Skip to main content
Version: 1.0.1

Count archive documents


Get the number of archived documents in a date range before creating an archive link. Use the returned documentCount as the documentCount value of Create archive link.

Endpoint​

PropertyValue
URLPOST /archive-link/count
MethodPOST
AuthR-Auth: <company-jwt>
Content-Typeapplication/json
Base URLStage Environment https://api-fr-stage.docnova.ai/
Production Environment https://api-fr.docnova.ai/

Example Request​

curl --location '{{baseUrl}}/archive-link/count' \
--header 'Content-Type: application/json' \
--header 'R-Auth: {{companyJwt}}' \
--data-raw '{
"companyId": "{{companyId}}",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30"
}'

Request body​

{
"companyId": "<companyId>",
"dateFrom": "2026-01-01",
"dateTo": "2026-06-30"
}
FieldTypeRequiredDescription
companyIdUUIDYesCompany UUID
dateFromdateYesStart date, format YYYY-MM-DD
dateTodateYesEnd date, format YYYY-MM-DD. Must be yesterday or earlier

The range must not exceed 366 days, and dateFrom must not be after dateTo.

Response​

{
"documentCount": 128,
"paymentRequired": false,
"undatedDocumentCount": 0,
"unprovableDocumentCount": 0
}

Response fields​

FieldDescription
documentCountNumber of archived documents in the range
paymentRequiredAlways false for white label partner companies
undatedDocumentCountArchived documents of the company that have no provable business date. They cannot be selected by any date range
unprovableDocumentCountInvoices in the range whose original could not be proven. They are listed in the zip but not included
note

The response also contains price fields (totalPrice, baseFee, unitPrice, taxRate, taxAmount, grandTotal). White label partner companies are not charged, so these values are 0.

Errors​

HTTPDescription
400Invalid date range: dateFrom is after dateTo, dateTo is today or later, or the range exceeds one year
401Missing or expired JWT
403The user is not allowed to manage archive links for this company
404Company not found