Skip to main content

Search documents


Search and filter submitted or received invoices for a company.

Endpoint

PropertyValue
URLPOST /invoice/search-documents
MethodPOST
AuthR-Auth: <company-jwt>
Content-Typeapplication/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

FieldTypeRequiredDescription
companyIdUUIDYesFilter by company
statusstringNoInvoice status filter. See status values below.
documentTypestringNoINCOMING or OUTGOING
invoiceSearchTypestringNoCREATE_DATE by default, ISSUE_DATE, or DUE_DATE
startDatedateNoDate in yyyy-MM-dd format
endDatedateNoDate in yyyy-MM-dd format
pageintegerNoPage number. Default is 0.
sizeintegerNoPage size. Default is 20, maximum is 200.

Status values

Document typeStatusDescription
INCOMINGSAVED_AS_UBLInvoice arrived via Peppol and is awaiting action
OUTGOINGSENT_TO_PEPPOLInvoice 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

FieldDescription
totalCountTotal number of matching documents
currencyTotals[].currencyCurrency code
currencyTotals[].totalAmountTotal invoice amount for the currency
currencyTotals[].netAmountNet amount for the currency
currencyTotals[].taxAmountTax amount for the currency
currencyTotals[].payableAmountPayable amount for the currency
invoiceListList of matching invoice records