Skip to main content
The Invoice Data Model simplifies the handling and retrieval of invoices from different payment gateways. The model provides a unified representation of invoices, enabling you to easily access and manage invoice data from different platforms.
  • Unified invoice properties: The model provides a unified representation of invoices, enabling you to easily access and manage invoice data from different platforms.
  • Comprehensive invoices information: The model provides a comprehensive representation of invoices, enabling you to easily access and manage invoice data from different platforms.

​
Attributes

​
Invoice Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the invoice
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 invoice
platform_idstringThe Platform’s ID for the invoice
platform_unique_idstringThe platform’s unique identifier for the invoice
contact_idstringThe contact id of the invoice
currency_idstringThe currency id of the invoice
document_numberstringThe document number of the invoice
posted_datestringThe posted date of the invoice
due_datestringThe due date of the invoice
statusstringThe status of the invoice
total_discountnumberThe total discount of the invoice
sub_totalnumberThe sub total of the invoice
tax_amountnumberThe tax amount of the invoice
total_amountnumberThe total amount of the invoice
amount_duenumberThe amount due of the invoice
shipping_amountnumberThe shipping amount of the invoice
memostringThe memo or notes for the invoice
created_atstringThe date and time the invoice was created
updated_atstringThe date and time the invoice was last updated
line_itemsLine Item[]The line items of the invoice
addressesAddress[]The addresses associated with the invoice

​
Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the line item
line_item_type_idstringThe ID of the parent document this line item belongs to
item_idstringThe item ID associated with the line item
tax_idstringThe tax ID associated with the line item
descriptionstringThe description of the line item
quantitynumberThe quantity of the line item
unit_amountnumberThe unit amount of the line item
line_item_typestringThe type of line item (PAYMENT_INVOICES, PAYMENT_PAYMENT_LINKS, etc.)
sub_totalnumberThe sub total of the line item
tax_amountnumberThe tax amount of the line item
total_amountnumberThe total amount of the line item
total_discountnumberThe total discount of the line item
updated_atstringThe date and time the line item was last updated

​
Address Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the address
platform_idstringThe Platform’s ID for the address
platform_unique_idstringThe platform’s unique identifier for the address
typeAddressTypeThe type of address (SHIPPING, BILLING, COMPANY)
data_model_idstringThe ID of the parent data model this address belongs to
streetstringThe street address
localitystringThe locality or neighborhood
citystringThe city
statestringThe state or province
pincodestringThe postal or zip code
countrystringThe country

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the invoice
contact_idstringThe contact id of the invoice
currency_idstringThe currency id of the invoice
document_numberstringThe document number of the invoice
posted_datestringThe posted date of the invoice
due_datestringThe due date of the invoice
statusstringThe status of the invoice
total_discountnumberThe total discount of the invoice
sub_totalnumberThe sub total of the invoice
tax_amountnumberThe tax amount of the invoice
total_amountnumberThe total amount of the invoice
amount_duenumberThe amount due of the invoice
shipping_amountnumberThe shipping amount of the invoice
memostringThe memo or notes for the invoice
created_atstringThe date and time the invoice was created
updated_atstringThe date and time the invoice was last updated
line_itemsobject[]The line items of the invoice
addressesobject[]The addresses associated with the invoice
{
  "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",
  "contact_id": "123456",
  "currency_id": "USD",
  "document_number": "INV-001",
  "posted_date": "2024-01-22T05:07:31.000Z",
  "due_date": "2024-02-22T05:07:31.000Z",
  "status": "SUBMITTED",
  "total_discount": 10.0,
  "sub_total": 90.0,
  "tax_amount": 9.0,
  "total_amount": 99.0,
  "amount_due": 99.0,
  "shipping_amount": 5.0,
  "memo": "Payment for services rendered",
  "created_at": "2024-01-22T05:07:31.000Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "line_items": [
    {
      "platform_id": "li_123456",
      "line_item_type_id": "123456",
      "item_id": "item_123",
      "tax_id": "tax_123",
      "description": "Consulting services",
      "quantity": 1,
      "unit_amount": 100.0,
      "line_item_type": "PAYMENT_INVOICES",
      "sub_total": 100.0,
      "tax_amount": 10.0,
      "total_amount": 110.0,
      "total_discount": 10.0,
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ],
  "addresses": [
    {
      "rootfi_id": 278264,
      "platform_id": "addr_123456",
      "platform_unique_id": "123456",
      "type": "BILLING",
      "data_model_id": "123456",
      "street": "123 Main Street",
      "locality": "Downtown",
      "city": "New York",
      "state": "New York",
      "pincode": "10001",
      "country": "USA"
    }
  ]
}