General
Server Side SDKs
Core API
- Companies
- Invite Links
- Integrations
- Sync
- Jobs
- Passthrough
Unified API
- Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Documents
Get Documents
Retrieve Documents from the database based on the ID
POST
/
accounting
/
documents
/
all
Copy
curl --request POST \
--url https://api.rootfi.dev/accounting/documents/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"file_name": "test.pdf"
},
"filter": {
"file_type": {
"eq": "application/pdf"
}
}
}'
Copy
{
"data": {
"data": [
{
"platform_id": "3770712000000085065_3770712000000080327",
"document_type_id": "3770712000000080327",
"file_name": "test.pdf",
"file_type": "application/pdf",
"file_size": 254.8828125,
"document_type": "INVOICES",
"document_uploaded": false,
"download_link": "https://Example.com/upload?file=test.pdf",
"updated_at": "2021-08-04T10:00:00+05:30"
}
],
"total_count": 1
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}
The Documents Data Model simplifies the handling of document documents across various accounting platforms, providing a standardised approach to accessing and managing document-related information.
Copy
curl --request POST \
--url https://api.rootfi.dev/accounting/documents/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"file_name": "test.pdf"
},
"filter": {
"file_type": {
"eq": "application/pdf"
}
}
}'
Authorizations
Body
application/json
Response
200 - application/json
The response is of type object
.
Copy
curl --request POST \
--url https://api.rootfi.dev/accounting/documents/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"file_name": "test.pdf"
},
"filter": {
"file_type": {
"eq": "application/pdf"
}
}
}'
Copy
{
"data": {
"data": [
{
"platform_id": "3770712000000085065_3770712000000080327",
"document_type_id": "3770712000000080327",
"file_name": "test.pdf",
"file_type": "application/pdf",
"file_size": 254.8828125,
"document_type": "INVOICES",
"document_uploaded": false,
"download_link": "https://Example.com/upload?file=test.pdf",
"updated_at": "2021-08-04T10:00:00+05:30"
}
],
"total_count": 1
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}
Assistant
Responses are generated using AI and may contain mistakes.