{
  "platform_id": "3770712000000085065_3770712000000080327",
  "document_type_id": "3770712000000080327",
  "file_name": "Documents.csv",
  "file_type": "text/csv",
  "file_size": 254.8828125,
  "document_type": "INVOICES",
  "document_uploaded": false,
  "download_link": "https://rootfi-dev.s3.amazonaws.com/3770712000000085065_3770712000000080327",
  "updated_at": "2021-03-03T10:00:00.000Z"
}
  • Unified document properties: The model unifies essential document details, such as file name, file type, file size, and platform ID, making it easier to work with documents from different platforms.
  • Document type association: Documents can be linked to specific document types (e.g., bills, invoices, expenses) using the document_type_id and document_type properties, facilitating easy retrieval and organisation of documents.
  • File metadata: The model includes file type (MIME Type) and file size properties, enabling developers to handle documents appropriately and ensure compatibility with their applications.
  • Document upload status: When you request for a document to be downloaded, RootFi will download the document then cache the document on to its servers so future calls to download the document will be faster. The document_uploaded property indicates whether RootFi has uploaded the document to its servers.

Downloading the Document

After initially syncing the documents data document_uploaded will be false for all the documents. To download the document you must call the Download Documents API. This API will download the document and return a temporary download_link.

Attributes

platform_id
string
required

The accounting platforms ID for the document

document_type_id
string

The platform ID of the document type with which this document is linked to

file_name
string

Name of the document that was used on the accounting platform

file_type
string

The file type of the document as given by the accounting platform. Formatted as a MIME Type

file_size
float

The file size of the document in bytes

document_type
Data Model

The name of the data model with which this document is linked. Currently only these data models are supported: BILLS,INVOICES,EXPENSES.

document_uploaded
boolean

A value to verify that RootFi that uploaded the document to its servers

download_link
string

A temporary download link through which you can download the attachment. Will only be present if document_uploaded is true

updated_at
date
required

The last ISO 8601 timestamp that the data was updated at

raw_data
object

The raw JSON response we get from the accounting platform for that data.

Properties Supported

PropertyTypeDescription
platform_idstringThe accounting platforms ID for the document
file_namestringName of the document that was used on the accounting platform
file_typestringThe file type of the document as given by the accounting platform. Formatted as a MIME Type
file_sizefloatThe file size of the document in bytes
document_type_idstringThe platform ID of the document type with which this document is linked to
document_typeData ModelThe name of the data model with which this document is linked. Currently only these data models are supported: BILLS,INVOICES,EXPENSES
download_linkstringA temporary download link through which you can download the attachment. Will only be present if document_uploaded is true
document_uploadedbooleanA value to verify that RootFi that uploaded the document to it’s servers
updated_atdateThe last ISO 8601 timestamp that the data was updated at