curl --request GET \
--url https://api.syntage.com/invoices/batch-payments \
--header 'X-API-Key: <api-key>'{
"@context": "/contexts/InvoiceBatchPayment",
"@id": "/invoices/batch-payments",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoiceBatchPayment",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"date": "2023-11-07T05:31:56Z",
"paymentMethod": "04",
"currency": "MXN",
"exchangeRate": 19.8,
"amount": -53249.8,
"operationNumber": "1022030122",
"beneficiaryBank": {
"rfc": "IIA040805DZ4",
"accountNumber": "12343453245633"
},
"payerBank": {
"rfc": "IIA040805DZ4",
"name": "International bank",
"accountNumber": "12343453245633"
},
"payments": [
{
"@id": "/invoices/payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoicePayment",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"invoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"currency": "MXN",
"exchangeRate": 19.8,
"installment": 3,
"previousBalance": 53249.8,
"amount": -53249.8,
"outstandingBalance": 0,
"invoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"batchPayment": "/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"invoice": {
"@id": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "Invoice",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"version": 3.3,
"reference": "Branch-A",
"internalIdentifier": "00001",
"type": "I",
"usage": "G03",
"paymentType": "PUE",
"paymentMethod": "04",
"paymentTerms": "immediate_payment",
"placeOfIssue": "01210",
"issuer": {
"rfc": "AOM920820BEA",
"name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
"taxRegime": 601,
"blacklistStatus": null
},
"isIssuer": true,
"receiver": {
"rfc": "PEIC211118IS0",
"name": "Pedro Infante Cruz",
"blacklistStatus": "presumed"
},
"isReceiver": false,
"currency": "MXN",
"discount": 3324,
"tax": 5224,
"subtotal": 51349.8,
"creditedAmount": 31.32,
"subtotalCreditedAmount": 27,
"total": 53249.8,
"exchangeRate": 19.8,
"paidAmount": 53249.8,
"dueAmount": 0,
"lastPaymentDate": "2023-11-07T05:31:56Z",
"fullyPaidAt": "2023-11-07T05:31:56Z",
"paymentTermsRaw": "Tarjeta de crédito",
"status": "VIGENTE",
"pac": "SAT970701NN3",
"issuedAt": "2019-01-03T21:10:40.000Z",
"certifiedAt": "2019-01-03T21:10:41.000Z",
"cancellationStatus": "Cancelable con aceptación",
"cancellationProcessStatus": "En proceso",
"canceledAt": "2023-11-07T05:31:56Z",
"relations": [
{
"@id": "/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1",
"@type": "InvoiceRelation",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"type": 7,
"invoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
"relatedInvoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
"relatedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"xml": true,
"pdf": true,
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z",
"tags": [
{
"@id": "/tags/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "Tag",
"id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
"name": "To be reviewed",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
]
},
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"hydra:view": {
"@id": "<string>",
"@type": "hydra:PartialCollectionView",
"hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
"hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
},
"hydra:search": {
"@type": "<string>",
"hydra:template": "<string>",
"hydra:variableRepresentation": "<string>",
"hydra:mapping": [
{
"@type": "<string>",
"variable": "<string>",
"property": "<string>",
"required": true
}
]
}
}List all batch payments related to your invoices
curl --request GET \
--url https://api.syntage.com/invoices/batch-payments \
--header 'X-API-Key: <api-key>'{
"@context": "/contexts/InvoiceBatchPayment",
"@id": "/invoices/batch-payments",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoiceBatchPayment",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"date": "2023-11-07T05:31:56Z",
"paymentMethod": "04",
"currency": "MXN",
"exchangeRate": 19.8,
"amount": -53249.8,
"operationNumber": "1022030122",
"beneficiaryBank": {
"rfc": "IIA040805DZ4",
"accountNumber": "12343453245633"
},
"payerBank": {
"rfc": "IIA040805DZ4",
"name": "International bank",
"accountNumber": "12343453245633"
},
"payments": [
{
"@id": "/invoices/payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoicePayment",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"invoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"currency": "MXN",
"exchangeRate": 19.8,
"installment": 3,
"previousBalance": 53249.8,
"amount": -53249.8,
"outstandingBalance": 0,
"invoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"batchPayment": "/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"invoice": {
"@id": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "Invoice",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"version": 3.3,
"reference": "Branch-A",
"internalIdentifier": "00001",
"type": "I",
"usage": "G03",
"paymentType": "PUE",
"paymentMethod": "04",
"paymentTerms": "immediate_payment",
"placeOfIssue": "01210",
"issuer": {
"rfc": "AOM920820BEA",
"name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
"taxRegime": 601,
"blacklistStatus": null
},
"isIssuer": true,
"receiver": {
"rfc": "PEIC211118IS0",
"name": "Pedro Infante Cruz",
"blacklistStatus": "presumed"
},
"isReceiver": false,
"currency": "MXN",
"discount": 3324,
"tax": 5224,
"subtotal": 51349.8,
"creditedAmount": 31.32,
"subtotalCreditedAmount": 27,
"total": 53249.8,
"exchangeRate": 19.8,
"paidAmount": 53249.8,
"dueAmount": 0,
"lastPaymentDate": "2023-11-07T05:31:56Z",
"fullyPaidAt": "2023-11-07T05:31:56Z",
"paymentTermsRaw": "Tarjeta de crédito",
"status": "VIGENTE",
"pac": "SAT970701NN3",
"issuedAt": "2019-01-03T21:10:40.000Z",
"certifiedAt": "2019-01-03T21:10:41.000Z",
"cancellationStatus": "Cancelable con aceptación",
"cancellationProcessStatus": "En proceso",
"canceledAt": "2023-11-07T05:31:56Z",
"relations": [
{
"@id": "/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1",
"@type": "InvoiceRelation",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"type": 7,
"invoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
"relatedInvoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
"relatedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"xml": true,
"pdf": true,
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z",
"tags": [
{
"@id": "/tags/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "Tag",
"id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
"name": "To be reviewed",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
]
},
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}
],
"hydra:view": {
"@id": "<string>",
"@type": "hydra:PartialCollectionView",
"hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
"hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
},
"hydra:search": {
"@type": "<string>",
"hydra:template": "<string>",
"hydra:variableRepresentation": "<string>",
"hydra:mapping": [
{
"@type": "<string>",
"variable": "<string>",
"property": "<string>",
"required": true
}
]
}
}Your API key is available in the Production and Sandbox dashboards.
The collection cursor pointer to the next page
The collection cursor pointer to the previous page
The number of items per page
1 <= x <= 1000Invoice batch payment collection response
Show child attributes
Invoice Batch Payment IRI reference
"/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice batch payment ID
"91106968-1abd-4d64-85c1-4e73d96fb997"
Payment date
Payment method code from c_FormaPago catalog
"04"
ISO 4217 alphabetic currency code
3"MXN"
Set when currency is different than MXN (Mexican Peso).
19.8
When the invoice issuer is the same taxpayer than the Entity it is considered an income and the sign is positive by the other hand when it is different the amount is considered as expense and the sign is negative. This field is the addition of all it´s payments amount
-53249.8
Operation identifier, it is used for internal control
"1022030122"
Show child attributes
Invoice Payment IRI reference
"/invoices/payments/91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice Payment ID
"91106968-1abd-4d64-85c1-4e73d96fb997"
The related deferred Invoice UUID (Folio fiscal)
"def404af-5eef-4112-aa99-d1ec8493b89a"
ISO 4217 alphabetic currency code
3"MXN"
Set when currency is different than MXN (Mexican Peso).
19.8
Payment installment
3
Amount before the payment
53249.8
When the invoice issuer is the same taxpayer than the Entity it is considered an income and the sign is positive by the other hand when it is different the amount is considered as expense and the sign is negative
-53249.8
Due amount after a payment
0
Invoice IRI reference
"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice Batch Payment IRI reference
"/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997"
Set when the payment invoice is canceled
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
Show child attributes
Invoice IRI reference
"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice ID
"91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice UUID (Folio fiscal)
"def404af-5eef-4112-aa99-d1ec8493b89a"
CFDI version
3.3
It is an open field for internal identification. Communly it is used to identify a branch
25"Branch-A"
It is an open field for internal identification. Communly it is used to identify an invoice
40"00001"
Invoice type code from c_TipoDeComprobante catalog
I, E, P, N, T Invoice usage code from c_UsoCFDI catalog
"G03"
Payment type code from c_MetodoPago catalog
PUE, PPD "PUE"
Payment method code from c_FormaPago catalog
"04"
Payment terms
immediate_payment, net_0, net_15, net_30, net_45, net_90, net_120 "immediate_payment"
Postal code of the place of issue
"01210"
Show child attributes
RFC (Registro Federal de Contribuyentes)
12 - 13"PEIC211118IS0"
Taxpayer name
1 - 254"Pedro Infante Cruz"
Tax regime code from c_RegimenFiscal catalog
601
Show the blacklist status if a taxpayer is found in the list 69-B from SAT
presumed, dismissed, definitive, favorable "presumed"
{
"rfc": "AOM920820BEA",
"name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
"taxRegime": 601,
"blacklistStatus": null
}true if the invoice issuer is the taxpayer from the entity
true
Show child attributes
RFC (Registro Federal de Contribuyentes)
12 - 13"PEIC211118IS0"
Taxpayer name
1 - 254"Pedro Infante Cruz"
Show the blacklist status if a taxpayer is found in the list 69-B from SAT
presumed, dismissed, definitive, favorable "presumed"
true if the invoice receiver is the taxpayer from the entity
false
ISO 4217 alphabetic currency code
3"MXN"
Discount amount
3324
Tax amount
5224
Subtotal amount
51349.8
Credited amount
31.32
Subtotal credited amount
27
Invoice total amount
53249.8
Set when currency is different than MXN (Mexican Peso).
19.8
For a deferred invoice this field state the paid amount. (Applies only for "PPD" invoices).
53249.8
For a deferred invoice this field state the due amount. (Applies only for "PPD" invoices).
0
This field is populated with the last related payment date (Applies only for "PPD" invoices).
This field is populated when the total debt is paid. (Applies only for "PPD" invoices).
The invoice payment terms text exactly as it comes from the invoice, i.e. immediate, 30 days, cash, credit card, etc
"Tarjeta de crédito"
Whether the invoice is active or canceled
VIGENTE, CANCELADO "VIGENTE"
Certification provider tax ID (Proveedor Autorizado de Certificación)
12"SAT970701NN3"
Invoice issue date
"2019-01-03T21:10:40.000Z"
Invoice certification date
"2019-01-03T21:10:41.000Z"
Whether or not the invoice can be canceled
Cancelable sin aceptación, Cancelable con aceptación, No cancelable "Cancelable con aceptación"
Set when the cancellation process starts
En proceso, Solicitud rechazada, Cancelado sin aceptación, Cancelado con aceptación, Plazo vencido "En proceso"
Set when status is CANCELADO
Show child attributes
Invoice Relation IRI reference
"/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1"
Invoice relation ID
"91106968-1abd-4d64-85c1-4e73d96fb997"
Invoice relation type code from c_TipoRelacion catalog
7
Invoice IRI reference
"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"
Invoice IRI reference
"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"
The related Invoice UUID (Folio fiscal)
"def404af-5eef-4112-aa99-d1ec8493b89a"
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
true when the CFDI is available in the XML format. The file can be downloaded through the retrieve an invoice CFDI operation
true when the CFDI is available in the PDF format. The file can be downloaded through the retrieve an invoice CFDI operation
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
Show child attributes
Resource tag IRI reference
"/tags/91106968-1abd-4d64-85c1-4e73d96fb997"
"e0a24894-7fbf-48ae-bfb0-efaae30a6319"
"To be reviewed"
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
Set when the payment invoice is canceled
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
Pagination information
Show child attributes
Current page IRI reference
Next page IRI reference. This property is omitted if there is no pagination.
"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
Last page IRI reference. This property is omitted if there is no pagination.
"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
Show child attributes