Skip to main content
Version: 1.0.0

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
Base URLStage Environment https://api-stage.docnova.ai/
Production Environment https://api.docnova.ai/

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 as UBL (XRechnung UBL / PEPPOL BIS) and is awaiting action
INCOMINGSAVED_AS_CIIInvoice arrived as CII (XRechnung CII) and is awaiting action
INCOMINGSAVED_AS_ZUGFERDInvoice arrived as ZUGFeRD/Factur-X and is awaiting action
INCOMINGSAVED_AS_PDFInvoice arrived as PDF and is awaiting action
INCOMINGCREDIT_BLOCKEDInvoice stored but blocked because the company has no incoming-document credit left
INCOMINGWORKFLOW_REJECTEDInternal approval workflow rejected the invoice; a credit note draft was created
INCOMINGOUTGOING_RESPONSE_ACKNOWLEDGEDMLR acknowledgement (AB) sent by us to the supplier
INCOMINGOUTGOING_RESPONSE_ACCEPTEDMLR acceptance (AP) sent by us to the supplier
INCOMINGOUTGOING_RESPONSE_REJECTEDMLR rejection (RE) sent by us to the supplier
OUTGOINGSAVED_AS_UBLInvoice created as UBL (XRechnung UBL / PEPPOL BIS), not yet sent
OUTGOINGSAVED_AS_CIIInvoice created as CII (XRechnung CII), not yet sent
OUTGOINGSAVED_AS_ZUGFERDInvoice created as ZUGFeRD/Factur-X, not yet sent
OUTGOINGSAVED_AS_PDFInvoice created as PDF, not yet sent
OUTGOINGSENT_TO_PEPPOLInvoice successfully delivered via Peppol
OUTGOINGINVALID_PARAMETERSAccess point rejected the request due to invalid sending parameters
OUTGOINGTRANSPORT_ERRORPeppol delivery failed; the invoice is eligible for retry
OUTGOINGTRANSPORT_ERROR_NO_RETRYPermanent Peppol delivery failure; retry is disabled
OUTGOINGNO_SIGNAL_MESSAGE_RECEIVEDNo AS4 signal message received from the receiving access point
OUTGOINGAS4_ERROR_MESSAGE_RECEIVEDReceiving access point returned an AS4 error message
OUTGOINGINVALID_SIGNAL_MESSAGE_RECEIVEDAS4 signal message received but was invalid
OUTGOINGSENT_VIA_EMAILInvoice delivered to the customer by e-mail instead of Peppol
OUTGOINGINCOMING_RESPONSE_ACKNOWLEDGEDMLR acknowledgement (AB) received from the customer
OUTGOINGINCOMING_RESPONSE_ACCEPTEDMLR acceptance (AP) received from the customer
OUTGOINGINCOMING_RESPONSE_REJECTEDMLR rejection (RE) received from the customer

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