Skip to main content
The Orders Data Model simplifies the handling and retrieval of Orders data for your application. The model provides a unified representation of Orders data across different platforms, enabling you to easily access and manage Orders data from different platforms.
  • Unified Orders properties: The model provides a unified representation of Orders properties across different platforms, enabling you to easily access and manage orders data from different platforms.
  • Comprehensive orders information: The model provides a comprehensive representation of Orders data, including all the properties and relationships that you can retrieve for an order.

​
Attributes

​
Order Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the order
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the order
platform_idstringThe Platform’s ID for the Order
platform_unique_idstringThe platform’s unique identifier for the order
created_atstringThe date and time the Order was created
updated_atstringThe date and time the Order was last updated
referencestringThe reference of the order
amountnumberThe amount of the order
amount_duenumberThe amount due of the order
statusenumThe status of the order (CREATED, ATTEMPTED, PAID, CANCELLED)
currency_idstringThe currency of the order

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the Order
created_atstringThe date and time the Order was created
updated_atstringThe date and time the Order was last updated
referencestringThe reference of the order
amountnumberThe amount of the order
amount_duenumberThe amount due of the order
statusenumThe status of the order. Allowed values are CREATED, ATTEMPTED, PAID, CANCELLED
currency_idstringThe currency of the order
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "123456",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.465Z",
  "reference": "ORD-123456",
  "amount": 1000.00,
  "amount_due": 500.00,
  "status": "PAID",
  "currency_id": "USD"
}