--- title: "Get an invoice's details" method: GET path: "/api/invoices/{id}/" tags: ["Invoices"] --- # Get an invoice's details `GET /api/invoices/{id}/` Get the details of a specific invoice. {% admonition type="info" %} This resource may return deprecated fields. Please check the response documentation for more information. {% /admonition %} ## Path parameters - `id` string, uuid, required ## Query parameters - `omit` string - `fields` string ## Response `200` Ok - InvoiceWithIdSat - `id` string, uuid — Belvo's unique identifier for the current item. - `link` string, uuid, nullable — The `link.id` the data belongs to. - `collected_at` string, date-time, required — The ISO-8601 timestamp when the data point was collected. - `created_at` string, date-time — The ISO-8601 timestamp of when the data point was created in Belvo's database. - `invoice_identification` string, nullable, required — The fiscal institution's unique ID for the invoice. - `invoice_date` string, nullable, required — The date of the invoice, in `YYYY-MM-DD` format. - `status` string, nullable, required — The status of the invoice. Can be either *Vigente* (valid) or *Cancelado* (cancelled). - `invoice_type` 'Egreso' | 'Ingreso' | 'Nómina' | 'Pago' | 'Traslado', nullable, required — The fiscal institution's classification of the invoice. For Mexico's SAT, we return one of the following values: - `Egreso` - `Ingreso` - `Nómina` - `Pago` - `Traslado` - `type` 'OUTFLOW' | 'INFLOW' | 'null', nullable, required — The direction of the invoice (from the perspective of the Link owner). - `OUTFLOW` indicates a sent invoice. - `INFLOW` indicates a received invoice. - `tax_details` TaxDetailsInvoicesSat — General information about the taxes of the invoice. - `total_tax_retained` number, float — Total amount of retained taxes. - `total_tax_transferred` number, float — Total amount of transferred taxes. - `retained_taxes` object[] — List of retained taxes. - `tax_type` string, nullable — The tax type code for this retained tax, as defined by the legal entity in the country. - `tax` string — The type of retained tax (for example, ISR, IVA or IEPS). - `tax_percentage` number, float, nullable — The percentage of tax retained. - `pre_tax_amount` number, float, nullable — The amount before tax. - `tax_amount` number, float — The amount of retained tax. - `transferred_taxes` object[] — List of transferred taxes. - `tax_type` string, nullable — The tax type code (TipoFactor) for this transferred tax, as defined by the legal entity in the country. - `tax` string — The type of transferred tax (for example, ISR, IVA or IEPS). - `tax_percentage` number, float — The percentage of tax transferred. - `pre_tax_amount` number, float — The amount before tax. - `tax_amount` number, float — The amount of transferred tax. - `sender_id` string, nullable, required — The fiscal ID of the invoice sender - `sender_fiscal_regime` string, nullable — The tax regime of the sender, as defined by the legal entity in the country. - `sender_name` string, nullable, required — The name of the invoice sender. - `sender_tax_fraud_status` string, nullable — Indicates whether or not the sender is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.

Possible statuses are: - `INVESTIGATING`
The fiscal institution has identified irregularities and open an investigation regarding the taxpayer.
- `DISMISSED`
The fiscal institution has investigated the taxpayer and declared them innocent.
- `CONFIRMED`
The fiscal institution has confirmed that the taxpayer is guilty.
- `OVERTURNED`
The fiscal institution has reassessed a previously confirmed taxpayer and, based on new evidence, has taken the taxpayer off the tax fraud list.
- `NO_TAX_FRAUD_STATUS`
The receiver or sender is not found in the list (in other words, they are complying with the fiscal institution's regulations). - `receiver_id` string, nullable, required — The fiscal ID of the invoice receiver. - `receiver_postal_code` string — The postal code of the receiver. - `receiver_fiscal_regime` string, nullable — The tax regime of the receiver, as defined by the legal entity in the country. - `receiver_name` string, nullable, required — The name of the invoice receiver. - `receiver_tax_fraud_status` string, nullable — Indicates whether or not the receiver is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.

SAT updates the tax fraud list every three months.

For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.

Possible statuses are: - `INVESTIGATING`
The fiscal institution has identified irregularities and open an investigation regarding the taxpayer.
- `DISMISSED`
The fiscal institution has investigated the taxpayer and declared them innocent.
- `CONFIRMED`
The fiscal institution has confirmed that the taxpayer is guilty.
- `OVERTURNED`
The fiscal institution has reassessed a previously confirmed taxpayer and, based on new evidence, has taken the taxpayer off the tax fraud list.
- `NO_TAX_FRAUD_STATUS`
The receiver or sender is not found in the list (in other words, they are complying with the fiscal institution's regulations). - `cancelation_status` string, nullable, required — If the invoice is cancelled, this field indicates the status of the cancellation. - `cancelation_update_date` string, date, nullable, required — The date of the invoice cancelation, in `YYYY-MM-DD` format. - `certification_date` string, date, nullable, required — The date of the fiscal certification, in `YYYY-MM-DD` format. - `certification_authority` string, nullable, required — The fiscal ID of the certification provider. - `payment_type` string, nullable, required — The payment type code used for this invoice, as defined by the country legal entity. - 🇲🇽 Mexico SAT catalog reference article - `payment_type_description` string, nullable, required — *This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.* - `payment_method` 'PUE' | 'PPD' | 'null', nullable — The payment method code used for this invoice, as defined by the legal entity of the country. - 🇲🇽 Mexico SAT catalog reference article. For Mexico, we return `PUE`, `PPD`, or `null`. - `payment_method_description` string, nullable — *This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.* *The description of the payment method used for this invoice.* - `usage` string, nullable — The invoice's usage code, as defined by the legal entity of the country. - 🇲🇽 Mexico SAT catalog reference article - `version` string, nullable — The CFDI version of the invoice. - `place_of_issue` string, nullable — The postcode of where the invoice was issued. - `invoice_details` InvoiceDetailSat[], required — A list of descriptions for each item (purchased product or service provided) in the invoice. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `description` string, nullable, required — The description of the invoice item (an invoice can have one or more items). - `product_identification` string, nullable, required — The identification code of the product or the service, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico. - `quantity` number, float, nullable, required — The quantity of this invoice item. - `unit_code` string, nullable, required — The unit of measure, as defined by the legal entity in the country. \n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference. - `unit_description` string, nullable, required — The description of the item, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference. - `unit_amount` number, float, nullable, required — The price of one a singular item. - `discount` number, float, nullable — The discount amount applied to this invoice item. - `tax_subject_code` string, nullable — Indicates what tax this item is subject to, as defined by the legal entity in the country. - `identifier_number` string, nullable — The identification number of the item, as defined by the seller. This can be used to identify the product or service in the seller's system. - `pre_tax_amount` number, float, nullable, required — The total price for this item before tax is applied (`quantity` x `unit_amount`). - `tax_percentage` number, float, nullable, required — The tax percentage to apply. - `tax_amount` number, float, nullable, required — The amount of tax for this invoice item (`pre_tax_amount` x `tax_percentage`). - `total_amount` number, float, nullable, required — The total price for this invoice item (`pre_tax_amount` + `tax_amount`). - `retained_taxes` InvoiceDetailRetainedTaxSat[] — The retained tax on the invoice item. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `tax_type` string, nullable — The tax type code for this retained tax, as defined by the legal entity in the country. - `tax` string, nullable, required — The type of retained tax (for example, ISR, IVA or IEPS). - `tax_percentage` number, float, nullable, required — The percentage of tax retained. - `retained_tax_amount` number, float, nullable, required — The amount of retained tax. - `transferred_taxes` InvoiceDetailTransferredTaxSat[] — The transferred taxes related to the invoice. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `tax_type` string, nullable — The tax type code for this transferred tax, as defined by the legal entity in the country. - `tax` string, nullable, required — The type of transferred tax (for example, ISR, IVA or IEPS). - `tax_percentage` number, float, nullable, required — The percentage of tax transferred. - `transferred_tax_amount` number, float, nullable, required — The amount of transferred tax. - `currency` string, nullable, required — The currency of the invoice. For example: - 🇧🇷 BRL (Brazilian Real) - 🇨🇴 COP (Colombian Peso) - 🇲🇽 MXN (Mexican Peso) - 🇺🇸 USD (United States Dollar) - `subtotal_amount` number, float, nullable, required — The pretax amount of this invoice (sum of each item's `pre_tax_amount`). - `exchange_rate` number, float, nullable, required — The exchange rate used in this invoice for the currency. - `tax_amount` number, float, nullable, required — The amount of tax for this invoice (sum of each item's `tax_amount`). - `discount_amount` number, float, nullable, required — The total amount discounted in this invoice. - `total_amount` number, float, nullable, required — The total amount of the invoice (`subtotal_amount` + `tax_amount` - `discount_amount`) - `related_invoices` RelatedInvoiceSat[] — A list of related invoices. - `relationship_type` string, nullable — The type of relationship between this invoice and the related invoice, as defined by the legal entity in the country. For more information, see our SAT catalog reference article. - `related_invoice_identification` string, nullable — The SAT ID of the related invoice. - `payments` InvoicesPaymentsSat[], required — A list detailing all the invoice payments. - `date` string, date-time, nullable, required — ISO-8601 timestamp when the payment was made. - `payment_type` string, nullable, required — Payment type code used for this invoice, as defined by the country's legal entity. - 🇲🇽 Mexico SAT catalog reference article - `currency` string, nullable, required — The currency of the payment. For example: - 🇧🇷 BRL (Brazilian Real) - 🇨🇴 COP (Colombian Peso) - 🇲🇽 MXN (Mexican Peso) Please note that other currencies other than in the list above may be returned. - `exchange_rate` string, nullable, required — The `currency` to MXN currency exchange rate when the payment was made. - `amount` number, float, nullable, required — The invoice amount, in the currency of the original invoice. - `operation_number` string, nullable, required — The fiscal institution's internal identifier for the operation. - `beneficiary_rfc` string, nullable — The fiscal ID of the payment beneficiary. - `beneficiary_account_number` string, nullable, required — The bank account number of the payment beneficiary. - `payer_rfc` string, nullable, required — The fiscal ID of the payment issuer. - `payer_account_number` string, nullable, required — The bank account number of the payment issuer. - `payer_bank_name` string, nullable, required — The banking institution that was used by the payment issuer. - `related_documents` InvoicesPaymentsRelatedDocumentsSat[], required — A list of all the related deferred invoices affected by the payment. - `invoice_identification` string, nullable, required — The fiscal institution's unique ID for the related deferred invoice. - `currency` string, nullable, required — The currency of the related invoice. For example: - 🇧🇷 BRL (Brazilian Real) - 🇨🇴 COP (Colombian Peso) - 🇲🇽 MXN (Mexican Peso) Please note that other currencies other than in the list above may be returned. - `payment_method` string, nullable, required — The payment method of the related invoice. - `partiality_number` integer — The payment installment number. - `previous_balance` number, float, nullable, required — The invoice amount before the payment. - `amount_paid` number, float, nullable, required — The amount paid in this installment. - `outstanding_balance` number, float, nullable, required — The amount remaining to be paid. - `payroll` InvoicesPayrollSat, nullable, required — Details regarding the payroll payment. Only applicable for payroll invoices. - `days` integer, nullable, required — The number of days covered by the payment. - `type` string, nullable, required — The payroll type, as defined by the legal entity of the country. - 🇲🇽 Mexico SAT catalog reference article - `amount` number, float, required — The total amount of the payroll payment. - `version` string, required — The version of the payroll object. - `date_from` string, date, nullable, required — The start date of the payment period, in `YYYY-MM-DD` format. - `date_to` string, date, nullable, required — The end date of the payment period, in `YYYY-MM-DD` format. - `collected_at` string, date-time — The ISO-8601 timestamp when the data point was collected. - `payment_date` string, date, required — The payment date, in `YYYY-MM-DD` format. - `periodicity` 'DAILY' | 'WEEKLY' | 'TENTH_DAY' | 'FOURTEENTH_DAY' | 'FIFTEENTH_DAY' | 'MONTHLY' | 'BIMONTHLY' | 'PER_TASK' | 'COMMISSION' | 'ONE_OFF' | 'OTHER_PERIODICITY' | 'null', nullable — How often the payroll payment is made. For Mexico's SAT, we return one of the following values: - `DAILY` - `WEEKLY` - `TENTH_DAY` - `FOURTEENTH_DAY` - `FIFTEENTH_DAY` - `MONTHLY` - `BIMONTHLY` - `PER_TASK` - `COMMISSION` - `ONE_OFF` - `OTHER_PERIODICITY` - `earnings_breakdown` InvoicePayrollEarningsBreakdown[], nullable — A breakdown of the earnings for the payroll payment. - `type` string, nullable — The type of income. For a full list of possible values, please see the payroll earnings breakdown type table. - `taxable_amount` number, float — The amount of the income that is taxable. - `vat_free_amount` number, float — The amount of the income that is not subject to VAT. - `tax_deductions` InvoicePayrollTaxDeductions[], nullable — A breakdown of the tax deductions on the payroll payment. - `type` string, nullable — The type of tax deduction. For a full list of possible values, please see the payroll tax deductions type table. - `amount` number, float — The amount of the tax deduction. - `other_payments` InvoicePayrollOtherPayments[], nullable — A breakdown of other payments for the payroll. - `type` string, nullable — The type of other payment. For a full list of possible values, please see the payroll other payments type table. - `amount` number, float — The amount of the other payment. - `folio` string, nullable — The internal control number that the taxpayer assigns to the invoice. - `series` string, nullable — The series of the invoice, as defined by the taxpayer. This is an optional field used to group invoices. - `export_type` string, nullable — The export type of the invoice, as defined by the legal entity in the country. For more information, see our SAT catalog reference article. - `xml` string, nullable — XML of the invoice document. - `warnings` InvoiceWarningsSat, nullable — Object containing information about any warnings related to this invoice. - `code` string, nullable, required — The warning code. Can be one of: - `sat_xml_limit_reached` - `sat_service_unavailable` - `null` - `message` string, nullable, required — The description of the warning. The message will depend on the warning code: `sat_xml_limit_reached`
The daily limit for XML downloads set by SAT was reached so this invoice might be missing data. Please check https://tinyurl.com/yydzhy5d for more information on this error. `sat_service_unavailable`
Downloading invoices details is not available. The SAT portal raised a 503 error. - `sender_blacklist_status` string, nullable — *This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.* Please use `sender_tax_fraud_status` instead. - `receiver_blacklist_status` string, nullable — *This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.* Please use `receiver_tax_fraud_status` instead. ## Other responses - `401` — Unauthorized - `403` — Access to Belvo API denied - `404` — Not Found Error - `408` — Request Timeout - `500` — Unexpected Error --- [API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/versions/3423c786ece5/schema)