Skip to main content

Integrate once. Issue everywhere.

Python PyPI License

API Reference · Python SDK guide


stackin

Python SDK for fiscal document issuance — a handful of business fields, nothing about certificates, XML, XSD, signing or SOAP. The API resolves all of that from the issuer's own configuration, identified by api_key.

One class, Invoice — issue()/consult()/cancel()/reissue()/correct()/invalidate()/pdf()/received()/manifest(), nothing else to instantiate. Each line item is a Product (stackin.br) — description plus either unit_price or amount are universal, everything else (ncm/cfop/cest/tax groups...) is Brazil-specific and only required for NFE; NFSE ignores it.

What a line item is worth

unit_price is the price of one unit. amount is the gross total of the line's products, before discount, freight, insurance and other expenses. Send either; sending both asserts that they agree.

from decimal import Decimal

# One unit
Product(description="Consultoria", quantity=Decimal("1"), unit_price=Decimal("1500.00"))

# More than one unit — amount is computed as 2 x 120.00 = 240.00
Product(description="Teclado", quantity=Decimal("2"), unit_price=Decimal("120.00"))

# A fractional quantity — 1.5 x 30.00 = 45.00
Product(description="Cabo", quantity=Decimal("1.5"), unit_price=Decimal("30.00"))

# Legacy: amount alone still means the line's gross total
Product(description="Servico", quantity=Decimal("3"), amount=Decimal("150.00"))

# Both, checked against each other before the document is transmitted
Product(
    description="Teclado",
    quantity=Decimal("2"),
    unit_price=Decimal("120.00"),
    amount=Decimal("240.00"),
)

# With charges: 5000.00 - 100.50 + 40.00 + 10.00 = 4949.50 on the note
Product(
    description="Servidor",
    quantity=Decimal("2"),
    unit_price=Decimal("2500.00"),
    discount=100.50,
    freight=40.00,
    insurance=10.00,
)

Amounts that do not add up are refused before the authorizer sees them, with a 422 naming the line and both numbers:

{
  "detail": {
    "code": "ITEM_TOTAL_MISMATCH",
    "field": "items[0].amount",
    "message": "amount is 50.00, but quantity x unit_price is 150.00.",
    "expected": "150.00",
    "received": "50.00"
  }
}

Migrating

Before:  quantity = 3, amount = 150.00
After:   quantity = 3, unit_price = 50.00

Nothing has to migrate. amount keeps the meaning it always had and is not deprecated in this release; a line sent with amount alone is built exactly as it was before.

Install

pip install stackin-python-sdk

Usage

Get an api_key from the stackin dashboard — select the issuing company, then Settings → API key (context sdk). One key per issuing company, shown once at creation. The API resolves the issuer (CNPJ, state, address, certificate, environment) entirely from it; nothing about the issuer is ever passed on a call.

from decimal import Decimal

from stackin import Invoice, DocumentType, Address
from stackin.br import Product  # Brazil-specific line item — NCM/CFOP

client = Invoice(api_key="COMPANY_API_KEY")  # defaults to https://sdk.stackin.io

invoice = client.issue(
    document_type=DocumentType.NFSE,
    client_name="John Doe",
    tax_id="00000000000",
    items=[Product(description="Software development", unit_price=Decimal("5000.00"))],
)

status = client.consult("ACCESS_KEY...", document_type=DocumentType.NFSE)
client.cancel(
    "ACCESS_KEY...",
    document_type=DocumentType.NFSE,
    reason="Typo",
)
client.reissue(invoice["id"])  # retries a rejected/failed submission

# The authorizer's PDF, as raw bytes. NFS-e only; the XML stays the
# legally valid document, and a 502 here means the authorizer is down.
with open("nota.pdf", "wb") as file:
    file.write(client.pdf(access_key, document_type=DocumentType.NFSE))

# NFE requires ncm/cfop on every item, plus the buyer's full recipient_address:
client.issue(
    document_type=DocumentType.NFE,
    client_name="Buyer Company Ltd",
    tax_id="11111111111111",
    items=[
        Product(
            description="Teclado",
            quantity=Decimal("2"),
            unit_price=Decimal("120.00"),
            unit="UN",
            ncm="84716052",
            cfop="5102",
        )
    ],
    recipient_address=Address(
        street="Avenida Atlantica",
        number="500",
        neighborhood="Copacabana",
        city="Rio de Janeiro",
        state="RJ",
        zip_code="22010000",
    ),
    external_reference="order-1234",
)

external_reference is your own id for the document — an order number, a ticket. It is stored as sent, returned on every read and webhook, and GET /invoices?external_reference= finds the document by it.

recipient_address is an Address — the buyer's address, required for NFE. On NFE street, number, neighborhood, city, state and zip code are required (a buyer abroad trades the zip code for a country, see A buyer abroad): it becomes enderDest on the wire and the SEFAZ rejects a partial one. city_code (the 7-digit IBGE municipality code) may be left out — the API resolves it from city and state and answers CITY_NOT_FOUND (422) when it cannot; send it yourself when the name is ambiguous. state is also what resolves idDest — a buyer in another state is emitted as an interstate operation automatically. On NFSE it is the tomador's address: optional, except when any item has tax_retained=True (the ISSQN retained by the tomador), where the city authorizer refuses the document without it (E0237) — then every field except city_code is required. In both cases a missing or incomplete address raises a ValueError locally, before the request goes out.

items is a list of Product (stackin.br) — description/amount apply to any document type; ncm/cfop (plus everything else on Product: cest, tax groups, presumed credits...) are Brazil-specific and required per item for NFE, ignored for NFSE (a service isn't a physical good). ncm is the full 8 digits, or 00 for a service line — the SEFAZ rejects any other short code (rejection 777), so one fails at construction. recopi_number must be the 20-digit RECOPI number; the SDK checks its two modulo-11 check digits (MOC §8.5) before sending.

Optional document fields

Each of these is left out of the request body when unset, so a call that does not use them sends exactly what it sent before. The SDK checks only types and enums locally; the fiscal rules on them are the API's, answered as an APIError that names the rule.

discount — a Decimal (zero or more) taken off the whole document; the API spreads it over the lines:

client.issue(..., discount=Decimal("15.00"))

issued_at — the emission moment, a timezone-aware datetime, sent as ISO 8601 with its offset. A naive one raises ValueError. NF-e: at most 30 days back and 5 minutes ahead; NFS-e: never ahead.

from datetime import datetime, timedelta, timezone

client.issue(..., issued_at=datetime(2026, 11, 15, 9, 30, tzinfo=timezone(timedelta(hours=-3))))

purpose — NF-e only, why it is issued: Purpose.NORMAL (the default), COMPLEMENTARY, ADJUSTMENT or RETURN:

from stackin import Purpose

client.issue(..., purpose=Purpose.COMPLEMENTARY, referenced_keys=["3526..."])

direction — NF-e only: Direction.OUT (the default) or Direction.IN, an incoming note the company issues itself, such as goods returned by the buyer:

from stackin import Direction

client.issue(..., purpose=Purpose.RETURN, direction=Direction.IN, referenced_keys=["3526..."])

referenced_keys — NF-e only, a list of the 44-character access keys this note refers to: required for COMPLEMENTARY (exactly one) and, but for a few CFOPs, for RETURN:

client.issue(..., purpose=Purpose.RETURN, referenced_keys=["35261112345678000195550010000000011000000014"])

A buyer abroad (NF-e)

A recipient_address with state="EX" is a buyer outside Brazil. There tax_id is left out, zip_code and city_code may be left out, and country_code (the BACEN code, not Brazil's 1058) is required, with country_name beside it. The SDK does not check the BACEN code's check digit: the official table has countries whose digit does not close.

foreign_id — the buyer's passport or other document (5 to 20 characters), in place of a CPF/CNPJ:

client.issue(..., recipient_address=Address(..., state="EX", country_code="2496", country_name="Estados Unidos"), foreign_id="P12345678")

export — an Export (stackin.br) naming where the goods leave Brazil, required for an outgoing note abroad: exit_state and place, optionally dispatch_place:

from stackin.br import Export

client.issue(..., export=Export(exit_state="SP", place="Porto de Santos"))

Fuel (NF-e)

fuel on a Product is the layout's fuel group (comb), needed for a fuel CFOP: anp_code (9 digits), anp_description and consumer_state are required; glp_percent, natural_gas_national_percent, natural_gas_imported_percent, starting_value, codif, temperature_quantity and biodiesel_percent are optional. It travels under the product's fuel key and is refused together with extra_groups["comb"]:

from stackin.br import Fuel, Product

Product(description="Gasolina C", ncm="27101259", cfop="5656", fuel=Fuel(anp_code="320102001", anp_description="GASOLINA C COMUM", consumer_state="SP"))

Retrying safely

Issuing is the one call you must not repeat blindly. If the response is lost — a timeout, a dropped connection — the document may well have been authorized, and a second attempt issues a second fiscal document: another credit, another number burned, and undoing it means cancelling, which has a deadline.

Pass idempotency_key to make the retry safe:

from decimal import Decimal

key = str(uuid.uuid4())

result = invoice.issue(
    document_type=DocumentType.NFSE,
    client_name="Maria Silva",
    tax_id="12345678909",
    items=[Product(description="Consultoria", unit_price=Decimal("1500.00"))],
    idempotency_key=key,
)

Retry with the same key and the same body and you get the first response back, replayed — no second document, no credit consumed. reissue() takes the same argument.

Situation What the API does
New key issues normally, records the response
Same key, same body replays the recorded response
Same key, different body APIError 422
Same key, first call still running APIError 409
Previous attempt failed key is released — the retry issues
Key older than 24 hours treated as new

Generate the key yourself and keep it for as long as you might retry — a uuid4 per business event, not per HTTP call. The SDK never generates one, because a key minted per call would protect nothing, and because two genuinely separate invoices for the same customer and amount on the same day are a normal thing to issue.

Correcting a document

Some mistakes don't need a cancellation. A wrong product name, wrong transport details, a typo in the extra information — a CC-e (carta de correção) fixes those, and it is free: no new credit, no burned series number, no reissue.

result = invoice.correct(
    "35240912345678000199550010000000011000000017",
    document_type=DocumentType.NFE,
    correction="Transportadora corrigida para Rapido Ltda",
)

The correction text is 15 to 1000 characters, checked locally before the call.

What a CC-e cannot fix: anything that changes the tax owed (base, rate, price, quantity, totals), the buyer or the seller, or the issue date. Those still mean cancelling and reissuing. The API sends the legally fixed wording that says exactly this, attached to every correction.

The original document does not change — the CC-e is an event attached to it, and the authorized XML stays as it was. A document accepts at most 20 of them, and they are numbered for you.

NF-e only. NFS-e has no correction letter — cancel and reissue it instead. The access key says which one it is: an NF-e access key is 44 characters, an NFS-e key 50. A key that is not an NF-e access key (44 characters: digits, with uppercase letters allowed in the first 12 positions of the issuer CNPJ, which can be alphanumeric from July 2026) raises a ValueError locally, before the call: correct is NFe only. NFSe has no correction letter — cancel and reissue instead. What only the API can know stays an APIError with status 409: an NF-e key sent with document_type=DocumentType.NFSE, or a key for a document the API does not hold.

Invalidating unused numbers

NF-e numbering is sequential and the SEFAZ expects it to have no gaps. A number gets reserved the moment issuing starts, so a submission that fails afterwards — a rejection, a timeout — leaves a hole in the series. Reporting that range is how you close it.

result = invoice.invalidate(
    series="1",
    number_start=10,
    number_end=12,
    reason="Numeracao reservada e nao utilizada por falha no ERP",
)

The reason is 15 to 255 characters and the range is inclusive; both are checked locally, as is number_end not being below number_start.

A number that already reached the authorizer can't be invalidated. The API checks its own records first and answers 409 naming the offending numbers, without a round trip — and the authorizer checks again for what we can't see from here.

NF-e only, and it takes no access key: there is no document to point at.

Documents issued against you

Everything above serves the issuer. These two serve the recipient: what suppliers billed to this CNPJ, and the formal answer to it.

Reading the list never calls the SEFAZ. The authorizer caps how many times a CNPJ may ask for its distribution per day, so collecting runs on a schedule on the API side and a page refresh cannot spend that allowance.

from stackin import Manifestation

page = client.received(limit=20)
for document in page["data"]:
    print(document["access_key"], document["issuer_name"], document["amount"])

client.manifest(access_key, manifestation=Manifestation.CIENCIA)
client.manifest(
    access_key,
    manifestation=Manifestation.OPERACAO_NAO_REALIZADA,
    reason="Mercadoria nunca chegou ao endereco",
)

Before you answer a document the SEFAZ sends only a summary (resNFe): access key, issuer, amount, date. The full document (nfeProc) arrives after a manifestation, and the schema field on each row says which one you hold.

The four answers are 210200 Confirmação da Operação, 210210 Ciência da Operação, 210220 Desconhecimento da Operação and 210240 Operação não Realizada. Only the last one takes a reason, and it requires one — both rules are checked locally, before the request goes out, because a round trip to be told a fixed rule is a round trip wasted.

Looking up a code, or who a CNPJ belongs to

Two more clients, for the tables an issuer reads while filling a document. Neither writes anything.

from stackin import FiscalReference, Taxpayer

ref = FiscalReference(api_key="...")          # country="BR" by default

ref.ncm.get("84716052")                       # one code
ref.ncm.search("teclado", limit=5)            # a page of matches
ref.cfop.get("5102")
ref.kinds()                                   # what this country has
ref.kind("ibs_cbs_class").get("000001")       # any kind, named or not
ref.search("teclado")                         # every kind at once

Taxpayer(api_key="...").get("00000000000191")

cfop, ncm, cest, cst, csosn, iss_service, icms_fuel and ibs_cbs_class have accessors. kind(name) reaches anything else, including a classification published after this release — ask kinds() rather than trusting this list.

metadata is passed through as the API sends it and differs per kind: utrib on an NCM, ncm_code on a CEST, tax_type on a CST, None on an ISS service.

Three things worth knowing before you loop:

  • These share the invoice read allowance — 600 calls a minute per key, the same bucket consult(), history(), received() and pdf() draw from. One search() page beats N get() calls.
  • Ordering is fixed (kind, then code, ascending). Unlike history(), these take no sort_by/order_by.
  • A 404 from Taxpayer does not mean the company does not exist. That registry reloads monthly, so a recently registered CNPJ is simply not in it yet. Do not build a validation rule on it.

Taxpayer has one method and keeps one: the registry holds the names and addresses of real people, so there is no search over it, by design.

Errors

  • stackin.APIError — the API responded with a non-2xx status (status_code, detail) — a 401 here means api_key is missing, wrong, or was rotated.
  • stackin.ConnectionFailedError — the API didn't respond (network/DNS/timeout).
  • ValueError — issue()'s items is empty, missing ncm/cfop on an item for NFE, an item description over 120 characters on NFE (the xProd limit; NFSE has no such limit), any string in an NFE request with a character the NF-e cannot carry (outside ISO-8859-1, latin1: an emoji, CJK, Cyrillic…; the error names the field — typographic quotes, dashes, ellipsis, bullet, € and ™ are not refused, the API converts them and folds tabs and line breaks into a space), a missing/incomplete recipient_address on NFE, or a missing/incomplete recipient_address (every field except city_code) on NFSE when any item has tax_retained=True (the ISSQN retained by the tomador).
  • ValueError — correct() with a key that is not an NF-e access key (44 characters): a correction letter exists only on NF-e; an NFS-e is cancelled and reissued instead. An NF-e key sent with DocumentType.NFSE, or one the API does not hold, is an APIError 409, not a ValueError.
  • pydantic.ValidationError (a ValueError) — a model built with a value the NF-e 4.00 XSD refuses: an ncm that is not 8 digits (or 00 for a service line), a barcode that is not SEM GTIN or an 8/12/13/14-digit GTIN with a valid GS1 check digit, a recopi_number that is not 20 digits with valid check digits, or an Address street/neighborhood under 2 characters once trimmed.

Building the full fiscal document (issuer data, service code, tax groups, schema-accurate XML) is the API's job — configured once per company, not passed on every call.

Examples

Runnable end-to-end scripts in examples/nfe/ and examples/nfse/ — one file per field/variant, from the bare minimum to every field filled. examples/consult_invoice.py, examples/cancel_invoice.py, and examples/reissue_invoice.py cover the operations that act on an already-issued document. examples/lookup_fiscal_reference.py and examples/lookup_taxpayer.py cover the two read-only clients.

Metadata

Release files for stackin-python-sdk 0.15.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stackin-python-sdk 0.15.1
File Size Uploaded Provenance Actions
stackin_python_sdk-0.15.1.tar.gz 32.9 kB With provenance Details for stackin_python_sdk-0.15.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for stackin-python-sdk 0.15.1
File Interpreter ABI Platform Actions
stackin_python_sdk-0.15.1-py3-none-any.whl Python 3 none any Details for stackin_python_sdk-0.15.1-py3-none-any.whl

Total release size: 62.6 kB

Release files / stackin_python_sdk-0.15.1.tar.gz

Download URL stackin_python_sdk-0.15.1.tar.gz
Size 32.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e5e72a9e83fc6eafae08f8564dcc89c40fdb6cceb28ba0027d78de521262694d
BLAKE2b-256 checksum
How to use checksums
54ab3a03b9ff509c1059c2fcd15d6d5dce614b5707cfa75a1242af399494376c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / stackin_python_sdk-0.15.1-py3-none-any.whl

Download URL stackin_python_sdk-0.15.1-py3-none-any.whl
Size 29.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2424bedd52a67df5dc28de7f1c7d8a54c819ffa30742c30088ddedf05539e631
BLAKE2b-256 checksum
How to use checksums
d677886bfb034bd14891f6b2c8b3eb744ec3ae4f4a9c295f1c4de45501c607a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for stackin-python-sdk 0.15.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for stackin_python_sdk-0.15.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page