Skip to main content
GET
/
accounting
/
documents
Get All Documents
curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/documents \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "rootfi_id": 123,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-25T09:00:00Z",
      "rootfi_updated_at": "2024-01-25T09:00:00Z",
      "rootfi_company_id": 456,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "file_name": "Example File Name",
      "file_type": "Example File Type",
      "file_size": "Example File Size",
      "document_type_id": "123456",
      "document_type": "Example Document Type",
      "document_uploaded": true,
      "updated_at": "2024-01-25T09:00:00Z"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
api_key
string
header
required

Query Parameters

​
limit
integer | null

The number of objects you want to retrieve

​
next
string | null

The next page of objects to retrieve

​
prev
string | null

The previous page of objects to retrieve

​
select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

​
rootfi_updated_at[gte]
string | null

Filter by rootfi_updated_at Greater than or Equal To.

​
rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

​
include_deleted_records
string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

​
return_count
string | null

Return the count of the objects. Supported values are true and false

​
sort[rootfi_created_at]
enum<string> | null

Sort by rootfi_created_at

Available options:
ASC,
DESC
​
sort[rootfi_updated_at]
enum<string> | null

Sort by rootfi_updated_at

Available options:
ASC,
DESC

Response

The data of the documents endpoint

​
data
accountingDocumentObject · object[]
required
​
prev
string | null

The previous page of objects to retrieve

​
next
string | null

The next page of objects to retrieve

​
total_count
integer | null

The total count of the objects