Skip to main content
POST
/
accounting
/
documents
/
all
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"
    }
  }
}'

{
  "data": {
    "data": [
      {
        "platform_id": "<string>",
        "document_type_id": "<string>",
        "file_name": "<string>",
        "file_type": "<string>",
        "file_size": 123,
        "document_type": "<string>",
        "document_uploaded": true,
        "download_link": "<string>",
        "updated_at": "<string>"
      }
    ],
    "total_count": 123
  },
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}
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. 
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

​
api_key
string
header
required

Body

application/json
​
take
integer | null
​
skip
integer | null
​
orderBy
accountingDocumentOrderByFields · object
​
filter
accountingDocumentFilterFields · object

Response

200 - application/json
​
data
accountingtypesGetAllDocumentsResponseHelper · object
required
​
request_timestamp
string<date-time>
required

The time at which the request was received by the server

​
response_timestamp
string<date-time>
required

The time at which the response was sent by the server

​
request_id
string
required

The unique ID of the request