Core Tax Retention Information

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "invoice_identification": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "version": "1.0",
  "code": 25,
  "issued_at": "2019-01-03T21:10:40.000Z",
  "certified_at": "2019-01-03T21:10:41.000Z",
  "cancelled_at": null,
  "sender_id": "JKUF980404P0",
  "sender_name": "Roberto Nunez Batman",
  "receiver_nationality": "NATIONAL",
  "receiver_id": "GYGK3207809L1",
  "receiver_name": "ACME LTD",
  "total_invoice_amount": 53249.8,
  "total_exempt_amount": 1000.8,
  "total_retained_amount": 1550.7,
  "total_taxable_amount": 43249,
  "xml": "=XML-STRING=",
  "retention_breakdown": [] // See the dedicated retention_breakdown section.
}

Parameter	Type	Description	Example
`id`	`string`	Belvo's unique identifier for the current item.	0d3ffb69-f83b-456e-ad8e-208d0998d71d
`link`	`string`	The `link.id` the data belongs to.	30cb4806-6e00-48a4-91c9-ca55968576c8
`collected_at`	`string (date-time)`	The ISO-8601 timestamp when the data point was collected.	2022-02-09T08:45:50.406032Z
`created_at`	`string (date-time)`	The ISO-8601 timestamp of when the data point was created in Belvo's database.	2022-02-09T08:45:50.406032Z
`invoice_identification`	`string`	The fiscal institution's unique ID for the invoice that the tax retention relates to.	def404af-5eef-4112-aa99-d1ec8493b89a
`version`	`string`	The CFDI version of the tax retentions.	1.0
`code`	`integer`	The tax retention code.	25
`issued_at`	`string (date-time)`	The ISO-8601 timestamp of when the tax retention was issued.	2019-01-03T21:10:40.000Z
`certified_at`	`string (date-time)`	The ISO-8601 timestamp of when the tax retention was certified.	2019-01-03T21:10:41.000Z
`cancelled_at`	`string (date-time)`	The ISO-8601 timestamp of when the tax retention was canceled (if applicable).	null
`sender_id`	`string`	The fiscal ID of the invoice sender.	JKUF980404P0
`sender_name`	`string`	The name of the invoice sender.	Roberto Nunez Batman
`receiver_nationality`	`string`	Whether the invoice receiver is a Mexican national or not. Possible values: `NATIONAL`, `FOREIGN`.	NATIONAL
`receiver_id`	`string`	The fiscal ID of the invoice receiver.	GYGK3207809L1
`receiver_name`	`string`	The name of the invoice receiver.	ACME LTD
`total_invoice_amount`	`number`	The total amount of the invoice that the tax retention relates to.	53249.8
`total_exempt_amount`	`number`	Total amount that is exempt from taxation.	1000.8
`total_retained_amount`	`number`	Total tax retained.	1550.7
`total_taxable_amount`	`number`	The total amount that can be taxed. Calculated as `total_invoice_amount - total_exempt_amount`.	43249
`xml`	`string`	The tax retention document in XML form.	=XML-STRING=
`retention_breakdown`	`array of objects`	A breakdown of the retained taxes.	See the retention_breakdown section for details.

retention_breakdown

In the retention_breakdown array of object, you can receive a detailed breakdown of all the retained taxes.

{
  "retention_breakdown": [
    {
      "base_amount": 0.03,
      "tax_type": "01",
      "retained_amount": 0,
      "payment_status": "PAID"
    }
  ]
}

Parameter	Type	Description	Example
`base_amount`	`number`	The base amount that was used to calculate the tax retention.	0.03
`tax_type`	`string`	Optional attribute to indicate the type of tax withheld for the period or year according to the SAT catalog.	01
`retained_amount`	`number`	The amount retained.	0
`payment_status`	`string`	Indicates whether or not the tax has been paid or not. Can be either: `PAID`, `PROVISIONED`.	PAID