Retrieves a list of invoices with optional filtering, sorting, and pagination.
Endpoint
GET /invoicesAuthentication
Required: Authorization header with valid token
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| sortBy | string | No | Field to sort by | updatedAt |
| sortDirection | string | No | Sort direction (ASC or DESC) | DESC |
| startDate | string | No | Filter invoices with start date from this date | 2024-01-01T00:00:00Z |
| endDate | string | No | Filter invoices with end date until this date | 2024-12-31T23:59:59Z |
| search | string | No | Search term for invoice fields | INV-2024 |
| clientId | uuid | No | Filter by specific client | 75f18aa7-b0aa-4d2c-b104-b513bec82a5f |
| status | string | No | Filter by invoice status (PENDING, PAID, UNPAID) | PENDING |
| bookingIds | string | No | Filter by booking IDs (comma-separated) | uuid1,uuid2 |
| externalId | string | No | Filter by external identifier | external-invoice-123 |
| title | string | No | Filter by invoice title | Invoice Title |
| number | string | No | Filter by invoice number | INV-2024-001 |
| lastMonth | boolean | No | Filter invoices from last month | true |
| responsiblePerson | string | No | Filter by responsible person | person-id |
| page | number | No | Page number (default: 1) | 1 |
| limit | number | No | Items per page (default: 20) | 20 |
Response
Success (200)
JSON
{
"content": [
"InvoiceEntity"
],
"total": "number"
}Response Field Descriptions:
content- Array of invoice objects (InvoiceEntity Schema)total- Total number of invoices matching the query criteria
Example Usage
Bash
curl -X GET "https://integration-api.ram.syniotec.com/invoices/v1/invoice-management/invoices" \
-H "Authorization: Bearer YOUR_TOKEN"