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.

Properties Supported

PropertyTypeDescription
platform_idstringPlatform’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
currency_idstringThe Platform’s ID of the currency for the bill
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
purchase_order_idsobjectArray of Purchase Order Ids associated with the bill
updated_atdateThe date at which the information was updated on the accounting platform

Expandable Attributes

You can expand the following attributes to get the related data

PropertyData ModelDescription
contactContactsThe contact that made the bill
currencyCurrenciesThe currency of the bill
bill_paymentsBill PaymentsThe bill payments associated to the bill
documentsDocumentsThe documents attached to the bill
addressesAddressesThe addresses associated with the bill
line_itemsLine ItemsThe line items associated with the bill

Addresses

PropertyTypeDescription
platform_idstringPlatform's ID for the address
typeenumThe type of address. Values are: BILLING, SHIPPING.
data_modelstringThe data model to which this address is linked. Values are COMPANY_INFO, CONTACTS, INVOICES, BILLS, EXPENSES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, SALES_ORDERS, PURCHASE_ORDERS
data_model_idstringThe unique identifier for the data model associated with this address
streetstringThe street information of the address
localitystringThe locality or neighborhood information of the address
citystringThe city information of the address
statestringThe state or region information of the address
countrystringThe country information of the address
pincodestringThe postal or zip code of the address
updated_atdateThe date and time at which the address information was last updated in the accounting platform

Line Items

PropertyTypeDescription
platform_idstringPlatform ID associated with this line item
item_idstringThe platform ID of the item associated with this line item
tax_idstringThe platform ID of the tax associated with this line item
account_idstringThe platform ID of the account associated with this line item
line_item_typeenumThe data model linked to the line item. Values are: BILLS, INVOICES, INVOICE_CREDIT_NOTES, BILL_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS,SALES_ORDERS,GOODS_RECEIPT_NOTES
line_item_type_idstringThe platform ID of the associated data model
descriptionstringThe description for this line item
quantityfloatThe quantity of the product/service for this line item
unit_amountfloatPrice per unit for this line item
sub_totalfloatThe pre tax total value for this line item
tax_amountfloatThe tax amount for this line item
total_amountfloatThe total value of this line item
tracking_category_idsobjectThe tracking category Ids associated with this line item

Line Items Expandable Attributes

You can expand the following attributes to get the related line item data

PropertyData ModelDescription
itemItemsThe item associated with this line item
tax_rateTax RatesThe tax associated with this line item
accountAccountsThe account associated to the invoice