{
  "platform_id": "1234567890123456789",
  "account_id": "1234567890123456789",
  "contact_id": "1234567890123456789",
  "currency_id": "3770712000000000099",
  "purchase_order_ids": ["3770712000000085084", "3770712000000085084"],
  "document_number": "AO-0001",
  "posted_date": "2023-01-24T00:00:00.000Z",
  "due_date": "2023-01-24T00:00:00.000Z",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at":
    }
  },
  "currency_rate": 1,
  "memo": null,
  "status": "PAID",
  "total_amount": 150,
  "sub_total": 150,
  "total_discount": 0,
  "tax_amount": 0,
  "amount_due": 0,
  "line_items": {
    "data": [
      {
        "platform_id": "1234567890123456789",
        "account_id": "1234567890123456789",
        "line_item_type_id": "1234567890123456789",
        "item_id": "1234567890123456789",
        "line_item_type": "BILLS",
        "tracking_category_ids": [],
        "tax_id": null,
        "description": "Line Items Description",
        "quantity": 123,
        "unit_amount": 150,
        "total_amount": 150,
        "sub_total": 150,
        "tax_amount": 0,
        "total_discount": 0,
        "updated_at": "2023-02-17T00:00:00.000Z"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "platform_id": "1234567890123456789",
        "payment_id": "7890123456789012345",
        "bill_id": "1234567890123456789",
        "currency_id": "3770712000000000099",
        "contact_id": "1234567890123456789",
        "account_id": "1234567890123456789",
        "amount": 150,
        "payment_date": "2023-02-03T00:00:00.000Z",
        "payment_mode": "Cash",
        "currency": {
          "data": {
            "platform_id": "3770712000000000099",
            "name": "Indian Rupee",
            "code": "INR",
            "symbol": "₹",
            "is_base_currency": true,
            "exchange_rate": 0,
            "updated_at": "2023-02-17T00:00:00.000Z"
          }
        },
        "currency_rate": 80,
        "memo": "Payment For Items Purchased",
        "document_number": "AO-0001",
        "updated_at": "2023-02-17T00:00:00.000Z"
      }
    ]
  },
  "documents": {
    "data": [
      {
        "platform_id": "3770712000000106157_3770712000000085084",
        "file_name": "sample_upload.xlsx",
        "file_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        "file_size": 6019.53125,
        "document_type_id": "3770712000000085084",
        "document_type": "BILLS",
        "document_uploaded": false,
        "download_link": "https://www.testdownload.com/download/3770712000000106157_3770712000000085084",
        "updated_at": null
      }
    ]
  },
  "updated_at": "2023-07-05T00:00:00.000Z"
}

The Bills Data Model is designed to simplify the handling and retrieval of bill-related information across various accounting platforms.

  • Unified bill properties: The model unifies essential bill information such as vendor, account, dates, currency, and amounts, enabling a unified view of bills from different platforms.
  • Status tracking: The model supports tracking the status of a bill, including draft, submitted, partially paid, paid, overdue, void, or unknown, for better bill management and reporting.
  • Relationship with other data models: The model allows for the inclusion of associated line items, bill payments, and purchase orders, providing a complete picture of each bill.
  • Currency conversion: The currency_rate property allows for easy currency conversion between the payment currency and the base currency, ensuring accurate financial reporting and analysis.

Attributes

platform_id
string
required

Accounting platform’s ID for the bill

account_id
string

The accounting platform’s unique ID of the account associated with the bill

contact_id
string

The accounting platform’s unique ID of the contact associated with this bill

currency_id
string

The currency data associated with the bill.

purchase_order_ids
Array

Array of Purchase Orders Id associated with the bill

document_number
string

Reference number for the bill

posted_date
date

Date of creation of the bill

due_date
date

The due date for the bill

currency
string

The currency data associated with the bank transaction.

currency_rate
float

Rate between the currency of the payment and the base currency

status
enum

The status of the bill. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN.

total_amount
float

Total amount of the Bill

sub_total
float

Total pre tax amount of the Bill

total_discount
float

Total discount amount levied on the Bill

tax_amount
float

Total tax amount levied on the bill

amount_due
float

Outstanding amount to be paid for the Bill

line_items
Line Item

Line Items associated with the bill

payments
Bill Payment

Array of Bill Payments associated with the bill

contact
Contact

The contact who receives this bill

documents
Document

Array of Documents associated with the bill

updated_at
date

The date at which the information was updated on the accounting platform

raw_data
object

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

Properties Supported

PropertyTypeDescription
platform_idstringAccounting platform’s ID for the bill
account_idstringThe accounting platform’s unique ID of the account associated with the bill
contact_idstringThe accounting platform’s unique ID of the contact associated with this bill
document_numberstringReference number for the bill
posted_datedateDate of creation of the bill
due_datedateThe due date for the bill
currencystringThe ISO-4217 currency code
currency_ratefloatRate between the currency of the payment and the base currency
statusenumThe status of the bill. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_amountfloatTotal amount of the Bill
sub_totalfloatTotal pre tax amount of the Bill
total_discountfloatTotal discount amount levied on the Bill
tax_amountfloatTotal tax amount levied on the bill
amount_duefloatOutstanding amount to be paid for the Bill
line_itemsLine ItemArray of Bill Line items associated with the bill
paymentsBill PaymentArray of Bill Payments associated with the bill
contactContactThe contact who receives this bill
purchase_order_idsPurchase OrderArray of Purchase Orders Id associated with the bill
documentsDocumentArray of Documents associated with the bill
updated_atdateThe date at which the information was updated on the accounting platform