Should you notice any errors in our documentation, please don’t hesitate to contact us. Thank you!
List
GET
https://www-staging.givve.com/api/invoices
Last modified:2025-06-11 10:10:48
Invoices List
Filterable Attributes
| Attribute Name | Meaning |
|---|---|
| booked_on | Date of booking of the invoice |
| recipient_id | Id of invoice recipient, may be a customer or multiplier id |
| state | Current state of invoice: draft, booking, awaiting_direct_debit_submission, awaiting_payment, paid, or canceled |
Accessible By
Parameters:
| name | type | default | info |
|---|---|---|---|
| sort | string | NONE | OPTIONAL, defaults to -booked_on |
| skip_meta_totals | boolean | false | OPTIONAL, defaults to false |
| page[number] integer/string | 1 | OPTIONAL, defaults to 1 | |
| page[size] | integer/string | 25 | OPTIONAL, default page size is 25, max page size is 250 |
Return
{
"meta": {
"total_pages": 0,
"current_page": 0,
"page_size": 0,
"total_entries": 0
},
"data": [
{
"id": "string",
"created_at": "2025-04-24T10:26:44.046+02:00",
"updated_at": "2025-04-24T10:26:47.203+02:00",
"booked_on": "2025-04-24",
"creditor": "pl",
"due_on": "2025-04-24",
"paid_at": "2025-04-24T10:26:47.201+02:00",
"state": "paid",
"type": "unload_order_invoice",
"number": "1234567",
"orders": [
{
"id": "string",
"type": "unload_order"
}
],
"cancellation_number": null,
"cancelled_at": null,
"gross_amount": {
"cents": 0,
"currency": "EUR"
},
"net_amount": {
"cents": 0,
"currency": "EUR"
},
"payment_method": "bank_transfer",
"recipient": {
"id": "string",
"type": "customer"
},
"reference": null
}
],
"links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://www-staging.givve.com/api/invoices?sort=created_at&skip_meta_totals=&page[number]=0&page[size]=25'Response Response Example
{}Request
Query Params
sort
string
required
Example:
created_at
skip_meta_totals
string
required
page[number]
string
required
Example:
0
page[size]
string
required
Example:
25
Responses
Modified at 2025-06-11 10:10:48