Download Document

curl --request GET \
  --url https://api.rootfi.dev/v3/download_document/{document_id} \
  --header 'api_key: <api-key>'

{
  "data": {
    "rootfi_id": 1112,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-25T09:00:00Z",
    "rootfi_updated_at": "2024-01-25T09:00:00Z",
    "rootfi_company_id": 111,
    "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,
    "download_url": "https://example.com",
    "updated_at": "2024-01-25T09:00:00Z"
  }
}

GET

download_document

{document_id}

Download Document

curl --request GET \
  --url https://api.rootfi.dev/v3/download_document/{document_id} \
  --header 'api_key: <api-key>'

{
  "data": {
    "rootfi_id": 1112,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-25T09:00:00Z",
    "rootfi_updated_at": "2024-01-25T09:00:00Z",
    "rootfi_company_id": 111,
    "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,
    "download_url": "https://example.com",
    "updated_at": "2024-01-25T09:00:00Z"
  }
}

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

Path Parameters

document_id

string

required

The ID of the document

Query Parameters

rootfi_company_id

integer

required

The company ID of the document

Response

The data of the documents endpoint

data

accountingDownlaodDocumentObject · object

required

Show child attributes

data.rootfi_id

number<double>

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string<date-time>

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string<date-time>

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number<double>

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.rootfi_deleted_at

string<date-time> | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.file_name

string | null

The file name of the document

data.file_type

string | null

The file type of the document

data.file_size

string | null

The file size of the document

data.document_type_id

string | null

The document type ID of the document

data.document_type

string | null

The document type of the document

data.document_uploaded

boolean | null

The document uploaded of the document

data.download_url

string | null

The download URL of the document

data.updated_at

string | null

The updated date of the document

string | null

The previous page of objects to retrieve

string | null

The next page of objects to retrieve

total_count

integer | null

The total count of the objects

Create Document Get Documents

⌘I

General

Server Side SDKs

Core API

Unified API

Download Document

Authorizations

Path Parameters

Query Parameters

Response