Client Invoices

Retrieving the list of invoices

GET /api/v1/invoice/

Query Parameters

Name	Type	Description	Required
invoice_number	string	Invoice number	No
accounting_date_lt	string	Accounting date less than or equal (YYYY-MM-DD format)	No
accounting_date_gt	string	Accounting date greater than or equal (YYYY-MM-DD format)	No
cursor	string	Cursor for pagination	No
page_size	integer	Number of items per page (default: 20)	No

Response

Name	Type	Description
page_size	integer	Number of items per page
count	integer	Total number of items
next_page	string	URL of the next page
previous_page	string	URL of the previous page
results	array	List of invoices

Invoice details

Name	Type	Description
invoice_number	string	Invoice number
customer_name	string	Customer name
billing_site_ref	string	Billing site reference
billing_site_name	string	Billing site name
invoice_type	integer	Invoice type
invoice_type_label	string	Invoice type label
accounting_date	string	Accounting date
payment_deadline	string	Payment deadline

Example

{
  "page_size": 20,
  "count": 150,
  "next_page": "http://api.example.com/api/v1/invoice/?cursor=2&page_size=20",
  "previous_page": null,
  "results": [
    {
      "invoice_number": "FACTTSO25100246",
      "customer_name": "CLIENT EXAMPLE SA",
      "billing_site_ref": "SITE001",
      "billing_site_name": "Main Site",
      "invoice_type": 1,
      "invoice_type_label": "Standard Invoice",
      "accounting_date": "2025-10-27",
      "payment_deadline": "2025-11-26"
    }
  ]
}

Downloading an invoice

GET /api/v1/invoice/{invoice_number}/download/

Request Parameters

Name	Type	Description	Required
invoice_number	string	Invoice number	Yes

Response

The PDF file content of the invoice in binary format.

Response Headers

Header	Value
Content-Type	application/pdf
Content-Disposition	attachment; filename={invoice_number}.pdf

Error Handling

HTTP Code	Description
200	Success
401	User not authenticated
403	Permission denied
404	Invoice not found
500	Internal server error