Core Resources
- Events
- Files
- Exports
- Entities
- Tags
Extractions
- Extractions
- Schedulers
Datasource: SAT
- Credentials
- Invoices
- Tax Retentions
- Tax Returns
- Tax Compliance Checks
- Tax Status
- Electronic Accounting
Datasource: RPC
- Entidades
Datasource: RUG
- Operaciones
- RUG Garantias
- Garantias
Datasource: Syntage
- Score
Datasource: Buró de Crédito
- Reports
- Authorizations
Insights
- Invoicing Annual Comparison
- Vendor Network
- Customer Network
- Customer Concentration
- Supplier Concentration
- Employees
- Expenditures
- Financial Institutions
- Financial Ratios
- Government Supplier
- Invoicing Blacklist
- Risks
- Sales Revenue
- Trial Balance
- Scores
- Cash Flow
- RPC Shareholders
- Balance Sheet
- Income Statement
- Invoicing Concentration
Webhooks
- Overview
- Webhook Endpoints
- Webhook Requests
List an invoice's payments
List all payments related to the requested invoice
GET
/
invoices
/
{id}
/
payments
curl --request GET \
--url https://api.syntage.com/invoices/{id}/payments \
--header 'X-API-Key: <api-key>'
{
"@context": "<string>",
"@id": "<string>",
"@type": "hydra:Collection",
"hydra:member": [
{
"@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"
}
],
"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
}
]
}
}
Authorizations
Your API key is available in the Production and Sandbox dashboards.
Path Parameters
Invoice ID
Example:
"91106968-1abd-4d64-85c1-4e73d96fb997"
Query Parameters
The collection cursor pointer to the next page
The collection cursor pointer to the previous page
The number of items per page
Required range:
1 <= x <= 1000
Response
200
application/ld+json
Invoice payment collection response
The response is of type object
.
curl --request GET \
--url https://api.syntage.com/invoices/{id}/payments \
--header 'X-API-Key: <api-key>'
{
"@context": "<string>",
"@id": "<string>",
"@type": "hydra:Collection",
"hydra:member": [
{
"@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"
}
],
"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
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.