Skip to main content

Unofficial Facturapi.io Python wrapper

Project description

FacturAPI Unofficial Python client

This is an unofficial Python wrapper for FacturAPI

FacturAPI makes it easy for developers to generate valid Invoices in Mexico (known as Factura Electrónica or CFDI).

If you've ever used Stripe or Conekta, you'll find FacturAPI very straightforward to understand and integrate in your server app.

Install

pip install facturapi-python

Getting started

Create a customer

from facturapi import Facturapi

api = facturapi("FACTURAPI_SECRET_KEY")

new_customer = api.customers.create({
  "legal_name": "Dunder Mifflin",
  "tax_id": "ABC101010111",
  "tax_system": "601",
  "email": "email@example.com",
  "phone": 6474010101,
  "address": {
    "street": "Blvd. Atardecer",
    "exterior": 142,
    "interior": 4,
    "neighborhood": "Centro",
    "city": "Huatabampo",
    "municipality": "Huatabampo",
    "zip": 86500,
    "state": "Sonora",
    "country": "MEX"
  }
})

Create a product

from facturapi import Facturapi

api = facturapi("FACTURAPI_SECRET_KEY")

new_product = api.products.create({
    "description": "Ukelele",
    "product_key": 60131324,
    "price": 345.6,
    "tax_included": true,
    "taxability": "01",
    "taxes": [{
        "type": "IVA",
        "rate": 0.16
        }],
    "local_taxes": [],
    "unit_key": "H87",
    "unit_name": "Elemento",
    "sku": "string"
})

Create an invoice

from facturapi import Facturapi

api = facturapi("FACTURAPI_SECRET_KEY")

new_invoice = api.invoices.create({
    "customer": "YOUR_CUSTOMER_ID", # You can also use a customer object instead
    "payment_form": api.catalogs.payment_forms.TRANSFERENCIA_ELECTRONICA,
    "items": [{
    "quantity": 1,
    "product": 'YOUR_PRODUCT_ID' # You can also use a product object instead
  }]
})

Download your invoice

from facturapi import Facturapi

api = facturapi("FACTURAPI_SECRET_KEY")

with open("invoice.zip", "wb") as binary_file:
    invoice = api.invoices.download_zip("INVOICE_ID")
    binary_file.write(invoice)

Send your invoice by email

from facturapi import Facturapi

api = facturapi("FACTURAPI_SECRET_KEY")

message = api.invoices.send_by_email("INVOICE_ID", "customer@email.com")

Documentation

You can find more on what to do on the official documentation

Help

:warning: This is an unofficial project, the maintainers does not have any affiliation with FacturAPI or their developers. Any error with the service itself should be reported to the official support channels

Found a bug?

If you find a bug for this API client, please create an issue on the project's github page

Contribute

All PRs are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

facturapi_python-0.0.1.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

facturapi_python-0.0.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file facturapi_python-0.0.1.tar.gz.

File metadata

  • Download URL: facturapi_python-0.0.1.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for facturapi_python-0.0.1.tar.gz
Algorithm Hash digest
SHA256 7dc27cb35ad784e7042c6bc64a4ce27fb8b03c48e161b3b78a1b15601bdb5efc
MD5 c36c6e0ac664c620d99097bec0dac333
BLAKE2b-256 42c9131d7e7b4bd2b8bc8060dbfd35262e74fb122b488d6731b573c85282472d

See more details on using hashes here.

File details

Details for the file facturapi_python-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for facturapi_python-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8dc071b02bae2a2e2bc5b791aaf8a1323d12bada92b90ff3c409a54187eac709
MD5 d26d730b83362e05b0845eac9026fdd3
BLAKE2b-256 23476505aee81a6f25096c98ac3ee1204aafe55aeb7e92c5a9f7ba9303fa4441

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page