Bills
Overview
A record of goods or services purchased from a vendor
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
Property | Type | Description |
---|---|---|
platform_id | string | 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 |
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_id | string | The Platform’s ID of the currency for the bill |
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 |
purchase_order_ids | object | Array of Purchase Order Ids associated with the bill |
updated_at | date | The date at which the information was updated on the accounting platform |
Expandable Attributes
You can expand the following attributes to get the related data
Property | Data Model | Description |
---|---|---|
contact | Contacts | The contact that made the bill |
currency | Currencies | The currency of the bill |
bill_payments | Bill Payments | The bill payments associated to the bill |
documents | Documents | The documents attached to the bill |
addresses | Addresses | The addresses associated with the bill |
line_items | Line Items | The line items associated with the bill |
Addresses
Property | Type | Description |
---|---|---|
platform_id | string | Platform's ID for the address |
type | enum | The type of address. Values are: BILLING , SHIPPING . |
data_model | string | The 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_id | string | The unique identifier for the data model associated with this address |
street | string | The street information of the address |
locality | string | The locality or neighborhood information of the address |
city | string | The city information of the address |
state | string | The state or region information of the address |
country | string | The country information of the address |
pincode | string | The postal or zip code of the address |
updated_at | date | The date and time at which the address information was last updated in the accounting platform |
Line Items
Property | Type | Description |
---|---|---|
platform_id | string | Platform ID associated with this line item |
item_id | string | The platform ID of the item associated with this line item |
tax_id | string | The platform ID of the tax associated with this line item |
account_id | string | The platform ID of the account associated with this line item |
line_item_type | enum | The 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_id | string | The platform ID of the associated data model |
description | string | The description for this line item |
quantity | float | The quantity of the product/service for this line item |
unit_amount | float | Price per unit for this line item |
sub_total | float | The pre tax total value for this line item |
tax_amount | float | The tax amount for this line item |
total_amount | float | The total value of this line item |
tracking_category_ids | object | The 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
Property | Data Model | Description |
---|---|---|
item | Items | The item associated with this line item |
tax_rate | Tax Rates | The tax associated with this line item |
account | Accounts | The account associated to the invoice |