curl --request GET \
--url https://api.syntage.com/invoices/credit-notes \
--header 'X-API-Key: <api-key>'
{
"@context": "<string>",
"@id": "<string>",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/invoices/credit-note/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoicePayment",
"appliedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"issuedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"issuedAt": "2023-11-07T05:31:56Z",
"proportionalRate": 19.8,
"amount": 19.8,
"issuedInvoiceTotal": 19.8,
"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 credit notes related to invoices.
curl --request GET \
--url https://api.syntage.com/invoices/credit-notes \
--header 'X-API-Key: <api-key>'
{
"@context": "<string>",
"@id": "<string>",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/invoices/credit-note/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InvoicePayment",
"appliedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"issuedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
"issuedAt": "2023-11-07T05:31:56Z",
"proportionalRate": 19.8,
"amount": 19.8,
"issuedInvoiceTotal": 19.8,
"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 <= 1000
Invoice credit notes collection response
The response is of type object
.