id | string | Identifier (UUID). |
numero | string | null | Invoice number within its series. |
folio_fiscal | string | null | Identifier with the tax authority (the CFDI UUID in Mexico); null if it does not apply. |
cliente | string | null | Client the document is addressed to: the company name, or the details to create the client if it does not exist. |
estado | string | draft, open, paid, void or uncollectible. |
estado_fiscal | string | Issuance status: pending, issued, cancelled or error. |
pais | string | ISO 3166-1 alpha-2 country code. |
tipo | string | Document type: cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice or verifactu_credit_note. |
documento | "factura" | "factura_proforma" | "nota_credito" | "nota_debito" | How the document is titled. factura_proforma is a pro forma invoice: it is not an invoice and is not valid for tax purposes. It covers the proforma type and, in Spain, any document without a Verifactu record. |
moneda | string | null | ISO 4217 currency code. |
total | number | Amount in the currency given by `moneda`. |
pagado | number | Amount in the currency given by `moneda`. |
saldo | number | Amount in the currency given by `moneda`. |
vence | string | null | ISO 8601 date. |
vencida | boolean | true if the due date has passed with a balance due. |
cotizacion_id | string | null | ID of the related quote. |
creada | string | null | ISO 8601 date. |
language | "es" | "en" | "pt" | "fr" | "de" | null | Read-only. Language the invoice was issued in: es, en, pt, fr or de. null while it is a draft. |
subtotal | number | Amount in the currency given by `moneda`. |
impuestos | number | Amount in the currency given by `moneda`. |
moneda_contable | string | null | ISO 4217 currency code. |
tipo_cambio | number | null | Exchange rate stated from the sales currency to the accounting currency; null if they are the same. |
total_contable | number | null | Total converted to the accounting currency. |
notas | string | null | Internal notes; the client does not see them. |
nota_credito_de | string | null | ID of the invoice this credit note corrects. |
emisor | any | Tax details of the issuer. |
receptor | any | Tax details of the client receiving the invoice. |
descuento | object | null | Document discount, applied before tax and spread across line items; null if there is none. subtotal is already net. |
conceptos | object[] | Invoice line items with their tax. |
pagos | object[] | Payments received. |