Skip to main content
The Documents Data Model simplifies the handling of documents across various accounting platforms, providing a standardized approach to accessing and managing document-related information.
  • Unified document properties: Essential document details, such as file name, file type, file size, and platform ID, are standardized across different accounting 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

Attributes

Documents Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this document
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_integration_typeenum
platform_idstringUnique identifier for this document in the source accounting platform
file_namestringThe file name of the document
file_typestringThe file type of the document (MIME Type)
file_sizedoubleThe file size of the document in bytes
document_type_idstringThe document type ID of the document
document_typeenumThe document type of the document
document_uploadedbooleanWhether RootFi has uploaded the document to its servers
updated_atstringThe date and time the document was last updated

Document Type Enum Values

ValueDescription
BILLDocument is associated with a bill
INVOICEDocument is associated with an invoice
EXPENSEDocument is associated with an expense
BILL_CREDIT_NOTEDocument is associated with a bill credit note
INVOICE_CREDIT_NOTEDocument is associated with an invoice credit note
PURCHASE_ORDERDocument is associated with a purchase order
SALES_ORDERDocument is associated with a sales order
JOURNAL_ENTRYDocument is associated with a journal entry