NFC-e Consumer Invoices

Registers (or updates) a company for NFC-e issuance. Company name, IE, address and other data are extracted automatically via SintegraWS from the CNPJ. If the CNPJ already exists for the user, the NFC-e fields are updated and the existing company is returned.

Required headers

Body

* Required field. Other data (name, IE, address, etc.) are extracted automatically via SintegraWS from the CNPJ.

Updates the NFC-e company identified by the token header. All body fields are optional — send only those you want to change. When cep is updated, the system automatically resolves stateCode and ibge. When cert_content and cert_pwd come together, the certificate is validated before saving.

Required headers

Body (all fields optional — send ≥ 1)

At least 1 body field is required. CNPJ is immutable.

Returns the NFC-e company data identified by the token header. Note: method is POST but no body fields are required — the company is resolved only by token.

Required headers

Body

Empty. {} may be sent.

Creates an NFC-e tax category. Each category has a single scenario (internal outbound) and uses flat objects for ICMS, PIS, COFINS and IBS/CBS (no array, since NFC-e does not allow multiple scenarios per category). No IPI.

Required headers

Body (root)

icms

pis / cofins

ibs_cbs (optional)

* Required field.

Returns full data of an NFC-e tax category (description, CFOP, ICMS, PIS, COFINS and IBS/CBS).

Required headers

Query string

* Required field.

Returns a paginated list of NFC-e tax categories registered for the authenticated company.

Required headers

Query string

* Required field.

Required headers

Additional field

* Required field.

Removes an NFC-e tax category. Irreversible operation. Products bound to this category will continue referencing the removed category_id — update them first.

Required headers

Body

* Required field.

Issues an NFC-e (model 65, always intrastate outbound, no shipping). Key differences from the NFe endpoint: the consumer object is called client (not cliente); the address number is client.number; the consumer is optional; impostos.ipi, shipping_address, delivery_address and transportation do not exist. The value field in pag_info is named amount.

Required headers

Body (root)

client (optional)

Provide only if the consumer is identified. CPF or CNPJ must be sent as digits only.

products[] (each item)

pag_info[] (each item)

* Required field. ⚠ category_id or impostos, one of them is required.

Response fields (data)

Response — rejection / error

        {
          "success": false,
          "data": {
            "uuid": "65f8b9a1c2d3e4f5a6b7c8d9",
            "status": "Failed",
            "motivo": "Rejeição 226: Código da UF do Emitente diverge da UF autorizadora / 拒绝 226: 发件人所在州代码与授权州不一致",
            "nfce": 5,
            "serie": 1,
            "chave": "",
            "modelo": "nfce",
            "xml": "",
            "danfe": ""
          }
        }

Cancels an authorized NFC-e. Unlike NFe, the cancellation reason here is provided by the client and forwarded to the tax authority. The tax authority cancellation window is short (usually 15-30 minutes after authorization).

Required headers

Body

* Required field.

Response fields (data)

Response — error

        {
          "success": false,
          "data": {
            "motivo": "Rejeição: Pedido de Cancelamento intempestivo",
            "status": "Failed",
            "nfce": 5,
            "serie": 1,
            "chave": "35210112345678901234650010000000051234567890",
            "modelo": "nfce",
            "cStat": 501
          }
        }

Issues a return document for an authorized NFC-e. The return is an inbound NF-e (model 55) that references the access key of the original NFC-e in its XML; the NFC-e itself has no return document. The original is looked up among NFC-e records by uuid or chave, and items and tax fields are carried over from it. /api/invoice/return only searches NF-e records and answers "invoice does not exist" for any NFC-e; use this endpoint instead.

Required headers

Body

The return is an NF-e, and the recipient address is mandatory, whereas an NFC-e usually records no buyer address. When the original XML carries no address, cliente must include endereco, bairro, city, uf and cep; the endpoint lists whichever are missing.

Only an authorized NFC-e can be returned. The environment (production or test) follows the original and is neither required nor accepted as a parameter.

Repeated calls do not issue twice: when a return already exists for the same original in the same environment, that document is returned.

The whole document is returned. Items, quantities and tax fields come from the original; tax fields are resolved through the tax category first and, when the category is missing, copied from the CST and rates in the original XML.

Response fields (data)

Response — error

        {
          "success": false,
          "message": "A devolução é uma NF-e e exige o endereço do comprador; a NFC-e original não o traz. Informe em cliente: endereco, bairro, city, uf, cep / 退货票是 NF-e，必须有买方地址，原 NFC-e 没有。请在 cliente 里传：endereco、bairro、city、uf、cep"
        }

Returns the details of a specific NFC-e by UUID. Includes XML and DANFE (thermal receipt) URLs, plus customer data when provided.

Required headers

Query string

* Required field.

Returns the NFC-e DANFE URL (electronic fiscal receipt) as PDF, with a QR Code for the tax authority lookup. Generated on demand and cached by hash (access key + status); repeated calls return the existing URL.

Required headers

Body

* Required field.

Lists the company's NFC-e with pagination. Parameters are passed via query string (not in the body). The time filter is optional, but if used, both start_create_time and end_create_time are required.

Required headers

Query string

* Required field.

Batch-exports the company's production NFC-e by period (homologation/test notes are excluded). Generation is asynchronous: the first call starts the export and returns "status": "Processing"; repeat the same call (same body) until you receive "status": "Success" with the download url. XML and PDF are delivered as a .zip (one file per note); the spreadsheet as .xlsx or .csv. The result stays valid for 10 days: within that window the same parameters return the same file (notes issued after generation are not included — use a different period to generate a new file).

Required headers

Body

* Required field. Provide the period with start_create_time + end_create_time or with month.