List inbox incoming documents
inbox:inbox.readhttps://api.holded.com/api/v2/inboxReturns a cursor-paginated list of incoming documents in your inbox. Optional filters: `status` (comma-separated list of statuses: `new`, `processing`, `error`, `pending_to_verify`, `done`, `rejected`), `start_date`/`end_date` (ISO 8601 date range on creation date), `user_id` (comma-separated user IDs). Results are ordered by creation date descending (newest first). Pass `cursor` from the previous response to fetch the next page.
Parameters
Query parameters
stringoptionalOpaque pagination cursor from the previous response
integeroptional= 50Number of items per page. Defaults to 50, maximum 200.
stringoptionalComma-separated statuses to filter by (e.g. pending_to_verify,done)
string<date-time>optionalFilter documents created on or after this ISO 8601 date
string<date-time>optionalFilter documents created on or before this ISO 8601 date
stringoptionalComma-separated user IDs to filter by uploader
Request
import requests
url = "https://api.holded.com/api/v2/inbox?cursor=value&limit=50&status=value"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "string",
"status": "pending_to_verify",
"origin": {
"id": "string",
"name": "string",
"type": "upload",
"source": "string"
},
"document_number": "string",
"type": "invoice",
"outcome": {
"documentId": "string",
"documentNumber": "string",
"type": "string",
"isDraft": false,
"exportedAt": "2024-01-15T10:30:00Z",
"attached": false
},
"date": "2024-01-15T10:30:00Z",
"contact_name": "string",
"total": "100,00",
"file": {
"filename": "string",
"path": "string"
},
"thumbnail": "string",
"signature": {
"filename": "string",
"path": "string"
},
"scanned_at": "string",
"seen_at": "string",
"errors": [
"string"
],
"draft": {
"description": "string"
}
}
],
"cursor": "string",
"has_more": false
}Success responses
200List of incoming documentsapplication/jsonUnique identifier of the incoming document
Current status
newprocessingerrorpending_to_verifydonerejectedOrigin metadata
Document number extracted from the file
Document type
invoicesalesreceiptcreditnotepurchaseorderpurchaseshipmentsalesorderreceiptpurchaserefundestimatewaybillproformreceiptnoteinvoicerecurringpurchaserecurringpayrollpayrollrecurringamazonorderproductionorderinvoicingforecastLinked document outcome if the document has been processed
Creation date in ISO 8601 format
Name of the associated contact
Total amount as decimal string
Primary file associated with the document
Thumbnail URL (reserved for future use)
Certified digitization signature file
Date the document was scanned (ISO 8601)
Date the document was first seen (ISO 8601)
List of error codes if the scan failed
Draft metadata extracted from the document
Error responses
401Invalid or missing API keyapplication/json403Insufficient permissionsapplication/json429Rate limit exceededapplication/json