curl --request GET \
--url https://api.entendre.finance/v1/vault/documents \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.entendre.finance/v1/vault/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/vault/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "doc_6f31e8c4-41ce-47af-9db7-3ad295a0a601",
"organization_id": "org_123",
"document_type": "statement",
"document_source": "upload",
"file_size": 1,
"filename": "august-statement.pdf",
"original_filename": null,
"file_extension": "pdf",
"summary": null,
"confidence_level": 1,
"language": null,
"created_at": null,
"deleted_at": null,
"download_url": "https://files.example.com/documents/statement.pdf"
}
],
"has_more": false,
"next_cursor": null
}List documents
Lists documents, with optional typed details, statement lines and download URLs.
curl --request GET \
--url https://api.entendre.finance/v1/vault/documents \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.entendre.finance/v1/vault/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/vault/documents"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "doc_6f31e8c4-41ce-47af-9db7-3ad295a0a601",
"organization_id": "org_123",
"document_type": "statement",
"document_source": "upload",
"file_size": 1,
"filename": "august-statement.pdf",
"original_filename": null,
"file_extension": "pdf",
"summary": null,
"confidence_level": 1,
"language": null,
"created_at": null,
"deleted_at": null,
"download_url": "https://files.example.com/documents/statement.pdf"
}
],
"has_more": false,
"next_cursor": null
}search and search_term are the same filter; send only one. Bill filters need type=bill or no type. source_id and the reconciliation status filter select statement documents.
Filtered scans can return an empty page with has_more=true. Continue until next_cursor is null.
Expanded details
Setexpand=bill,receipt,vendor,statement to add the related records. Each expanded item contains document and the requested records.
Statement lines
Send one document ID withexpand=statement.lines. Read the lines from statement.lines.data, and pass its next_cursor as statement_cursor for the next page. Keep import_status, is_reconciled and the document filter unchanged between pages.
Download URLs
Adddownload to expand to get viewing and download URLs. This needs a user-scoped API key, and it records a document view, as opening the document in the dashboard does. The URLs expire after three days.Authorizations
Your organization API key. Some operations also need a key that is associated with a user; their pages say so.
Query Parameters
Comma-separated doc_<uuid> ids to filter by. Up to 100 IDs.
Earliest created date (YYYY-MM-DD).
Latest created date (YYYY-MM-DD).
Full-text match across extracted text, summary, filename, vendor name, and bill/receipt numbers.
Maximum number of records to return.
1 <= x <= 100The next_cursor value from the previous page. Keep the other filters unchanged.
Case-insensitive search in labels and descriptions.
Filter by document type.
bill, receipt, statement, other Source ID (src_…).
"src_507f1f77bcf86cd799439011"
Vendor ID (vnd_…).
"vnd_507f1f77bcf86cd799439011"
Comma-separated expansions: bill, receipt, vendor, statement, statement.lines or download. statement.lines and download require exactly one document_ids value. download requires a user-scoped API key.
Rows per statement page. Requires expand=statement.lines and exactly one document_ids value. Does not change the document page size.
1 <= x <= 100The statement.lines.next_cursor value from the previous page.
Vendor name (substring match).
Bill number.
Earliest bill date (YYYY-MM-DD).
Latest bill date (YYYY-MM-DD).
Earliest billing-period start (YYYY-MM-DD).
Latest billing-period end (YYYY-MM-DD).
Currency code (such as USD).
Minimum total amount, inclusive.
Maximum total amount, inclusive.
Minimum tax amount, inclusive.
Maximum tax amount, inclusive.
Minimum tax rate, inclusive.
Maximum tax rate, inclusive.
Nested statement-line filter. Requires expand=statement.lines.
pending, imported, ignored, duplicate, invalid Bill filter. Comma-separated vnd_ ids; a bill matches any of them. Combines with vendor_id. Requires type=bill or an omitted type.
100Statement filter on statement.reconciliation_status. Requires type=statement.
reconciled, not_reconciled Nested statement-line filter on is_reconciled. Requires expand=statement.lines.
Response
The request succeeded. With expand, each row is an envelope: document holds the document, next to the requested bill, receipt, vendor or statement.
The documents. Each item is a document, or an envelope when you send expand.
A document. id is doc_<uuid>.
- Option 1
- Option 2
Show child attributes
Show child attributes
Whether another page is available.
Cursor for the next page, or null on the last page.