Search documents
Search and filter submitted or received invoices for a company.
Endpoint
| Property | Value |
|---|---|
| URL | POST /invoice/search-documents |
| Method | POST |
| Auth | R-Auth: <company-jwt> |
| Content-Type | application/json |
Example Request
curl --location '{{baseUrl}}/invoice/search-documents' \
--header 'Content-Type: application/json' \
--header 'R-Auth: {{companyJwt}}' \
--data-raw '{
"companyId": "{{companyId}}",
"status": "SAVED_AS_UBL",
"documentType": "INCOMING",
"invoiceSearchType": "CREATE_DATE",
"startDate": "2026-01-01",
"endDate": "2026-06-01",
"page": 0,
"size": 20
}'
Request body
{
"companyId": "<companyId>",
"status": "SAVED_AS_UBL",
"documentType": "INCOMING",
"invoiceSearchType": "CREATE_DATE",
"startDate": "2026-01-01",
"endDate": "2026-06-01",
"page": 0,
"size": 20
}
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
companyId | UUID | Yes | Filter by company |
status | string | No | Invoice status filter. See status values below. |
documentType | string | No | INCOMING or OUTGOING |
invoiceSearchType | string | No | CREATE_DATE by default, ISSUE_DATE, or DUE_DATE |
startDate | date | No | Date in yyyy-MM-dd format |
endDate | date | No | Date in yyyy-MM-dd format |
page | integer | No | Page number. Default is 0. |
size | integer | No | Page size. Default is 20, maximum is 200. |
Status values
| Document type | Status | Description |
|---|---|---|
INCOMING | SAVED_AS_UBL | Invoice arrived via Peppol and is awaiting action |
OUTGOING | SENT_TO_PEPPOL | Invoice successfully delivered via Peppol |
Response
{
"totalCount": 42,
"currencyTotals": [
{
"currency": "EUR",
"totalAmount": 12500.00,
"netAmount": 10500.00,
"taxAmount": 2000.00,
"payableAmount": 12500.00
}
],
"invoiceList": []
}
Response fields
| Field | Description |
|---|---|
totalCount | Total number of matching documents |
currencyTotals[].currency | Currency code |
currencyTotals[].totalAmount | Total invoice amount for the currency |
currencyTotals[].netAmount | Net amount for the currency |
currencyTotals[].taxAmount | Tax amount for the currency |
currencyTotals[].payableAmount | Payable amount for the currency |
invoiceList | List of matching invoice records |