Product Bills
A commercial document issued by a seller/vendor, relating to a sale transaction and indicating the products, quantities and agreed costs for products the seller/vendor had provided along with the payment terms agreed.
| Field | Type | Description |
| amount | number | Amount of the bill including tax. |
| currency | string | Currency of the bill |
| id | string | Identifier for the bill, unique to the bill in the accounting platform. |
| lines | array | An array of bill lines |
| billingAddress | object | An object of billing address |
| billDate | date | Date of the bill as recorded in the accounting platform. |
| dueDate | date | Date the supplier is due to be paid. |
| modifiedDate | date | Date the record was last updated in the accounting system. |
| paymentTerms | object | An object of Payment Terms applied to the bill |
| vendor | object | An object of vendor associated with the bill |
| createdDate | date | Date the record was created in the accounting system. |
| department | object | An object of department for which the products have been ordered. |
| externalId | string | Friendly reference of the bill/reference of bill (invoice) from an external system |
| lastPaidDate | date | The date of the last payment pertaining to this bill |
| location | object | An object of location for which the products have been ordered. |
| payment | array | An array of payment details pertaining to this bill |
| status | string | Current status of this bill. |
| taxAmount | number | Total tax amount on the bill |
| creditLimit | number | Current credit limit available from the vendor. |
| description | string | The description / reference / notes associated with the bill |
| discountiDate | date | The date of discount recorded in the accounting system for the bill |
| isOnHold | boolean | Indicator of whether the bill is on hold or active |
| purchase-order | object | An object of purchase order associated with this bill |
| totalAmountDue | number | Total amount that is due against the bill |
| totalAmountPaid | number | Total amount that is paid against the bill |
| discountAmount | number | Total discount amount applied on the bill |
| glPostDate | date | The date of posting of this transaction in the accounting system (General Ledger) |
| account | string | The General Ledger account in which this transaction is posted |
| landedCost | number | The bill of lading cost associated with this bill |
| exchangeRate | number | Rate between the currency of the bill and the base currency. |
| subTotal | number | The total amount of bill excluding any taxes |
lines
| lines[*].department.id | string | The unique id of the department for which the product has been ordered. |
| lines[*].department.name | string | The name of the department for which the product has been ordered. |
| lines[*].description | string | The description / notes pertaining to the product |
| lines[*].location.id | string | The unique id of the location for which the product has been ordered. |
| lines[*].location.name | string | The name of the location for which the product has been ordered. |
| lines[*].product.cost | number | The unit cost of the product |
| lines[*].product.id | string | The unique identifier of the product to which the line is linked. |
| lines[*].product.name | string | The name of the product to which the line is linked. |
| lines[*].product.purchaseUom | string | The purchasing unit of measurement of the product to which the line is linked. |
| lines[*].quantity | number | The quantity of the product received |
| lines[*].subTotal | number | Amount of the line, inclusive of discounts but exclusive of tax. |
| lines[*].taxAmount | number | Amount of tax for the line. |
| lines[*].taxCode | string | The applicable tax code pertaining to the line |
| lines[*].account | string | The applicable General ledger account where the line is recorded |
| lines[*].taxRate | string | The tax rate to which the line is linked. |
| lines[*].totalAmount | number | The total amount of the line including taxes |
| lines[*].customer.id | string | The unique identifier of the customer who has ordered the item |
| lines[*].customer.name | string | The name of the customer who has ordered the item |
| lines[*].discountAmount | number | The total applicable discount on this line item |
| lines[*].id | string | The unique identifier of the line in the bill |
| lines[*].billableStatus | string | The current state of the line |
billingAddress:
| billingAddress.city | string | City of vendor’s billing address |
| billingAddress.country | string | Country of vendor’s billing address |
| billingAddress.id | string | Identifier of vendor’s billing address in accounting system |
| billingAddress.line1 | string | Address line1 of vendor’s billing address |
| billingAddress.line2 | string | Address line2 of vendor’s billing address |
| billingAddress.phone | string | Phone number of vendor’s billing address |
| billingAddress.postalCode | string | Postal code of vendor’s billing address |
| billingAddress.province | string | Province of vendor’s billing address |
| billingAddress.contact.firstName | string | First name of contact at vendor’s billing address |
| billingAddress.contact.middleName | string | Middle name of contact at vendor’s billing address |
| billingAddress.contact.lastName | string | Last name of contact at vendor’s billing address |
| billingAddress.contact.salutation | string | Salutation / Title of contact at vendor’s billing address |
| billingAddress.contact.email | string | Email of contact at vendor’s billing address |
paymentTerms:
| paymentTerms.id | string | Identifier of the payment terms. |
| paymentTerms.name | string | Name of the payment terms. |
vendor:
| vendor.id | string | Identifier of the supplier / vendor |
| vendor.name | string | Name of the supplier / vendor |
department:
| department.id | string | Identifier of the department |
| department.name | string | Name of the department |
location:
| location.id | string | Identifier of the location |
| location.name | string | Name of the location |
payment:
| payment[*].id | string | Identifier of the payment |
| payment[*].amount | number | Amount paid for this payment |
purchase-order:
| purchase-order.id | string | The unique identifier of purchase order |
