Invoice Aggregates

Retrieving the list of invoice aggregates

GET /api/v1/invoice-aggregate/

Query parameters

Name	Type	Description	Required
business_partner_code	string	Business partner code	No
generation_date_lt	string	Generation date less than or equal (YYYY-MM-DD format)	No
generation_date_gt	string	Generation date greater than or equal (YYYY-MM-DD format)	No
aggregate_number	string	Aggregate number	No
line_number	integer	Line number	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 invoice aggregates

Invoice aggregate details

Name	Type	Description
aggregate_number	string	Aggregate number
generation_date	string	Generation date
line_number	integer	Line number

Example

{
  "page_size": 20,
  "count": 45,
  "next_page": "http://api.example.com/api/v1/invoice-aggregate/?cursor=2&page_size=20",
  "previous_page": null,
  "results": [
    {
      "aggregate_number": "AGR250731006",
      "generation_date": "2025-07-31",
      "line_number": 1
    },
    {
      "aggregate_number": "AGR250731007",
      "generation_date": "2025-07-31",
      "line_number": 2
    }
  ]
}

Downloading an invoice aggregate

GET /api/v1/invoice-aggregate/{aggregate_number}/{line_number}/download/

Request parameters

Name	Type	Description	Required
aggregate_number	string	Aggregate number	Yes
line_number	integer	Line number	Yes

Response

The content of the invoice aggregate CSV file in binary format.

Response headers

Header	Value
Content-Type	text/csv
Content-Disposition	attachment; filename={aggregate_number}_{line_number}.csv

Error handling

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