Product Invoices
A commercial document issued to a customer, relating to a sale transaction and indicating the products, quantities and agreed prices for products shipped to the customer along with the payment terms agreed.
| Field | Type | Description |
| amount | number | Amount of the invoice, inclusive of tax. |
| currency | string | Currency of the invoice. |
| id | string | Identifier for the invoice, unique to the company in the accounting platform. |
| lines | array | An array of invoice line items. |
| billingAddress | object | An object of billing address |
| invoiceDate | date | Date of the invoice as recorded in the accounting system. |
| dueDate | date | Date the customer is due to be paid by. |
| modifiedDate | date | Date the record was last updated in the accounting system. |
| paymentTerms | object | An object of Payment Terms applied to the invoice |
| customer | object | An object of customer associated with the invoice |
| 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 invoice/reference of invoice from an external system |
| location | object | An object of location for which the products have been ordered. |
| payment | array | An array of payment details pertaining to the invoice |
| status | string | Current status of the invoice |
| taxAmount | number | Total tax amount against the invoice |
| taxCode | string | Default tax code applied to the invoice. |
| taxName | string | The tax description of the default tax to be applied to the invoice. |
| taxRate | string | Default tax rate applied to the invoice |
| description | string | The description / reference / notes associated with the invoice |
| discountDate | date | The date of discount recorded in the accounting system for the invoice |
| parentDocumentNumber | string | Customer purchase order/Sales order associated with this invoice |
| totalAmountDue | number | Total amount that is due on the invoice |
| totalAmountPaid | number | Total amount that is paid on the invoice |
| discountAmount | number | Numerical value of discounts applied to the invoice. |
| discountRate | string | Applied discount rate on the invoice |
| glPostDate | date | The date of posting of the transaction in the accounting system (General Ledger) |
| account | string | The General Ledger account in which the transaction is posted |
| language | string | Default language code used by the customer |
| exchangeRate | number | Rate between the currency of the invoice and the base currency. |
| subTotal | number | The total amount of invoice excluding taxes |
| fullPaymentDate | date | Date the invoice was marked as paid in the accounting system |
| shippingAddress | object | An object of shipping address |
| shippingCost | number | The cost incurred for shipping in the invoice |
| shippingMethod | string | The shipping method and terms used for the products in the invoice |
| shippingTaxAmount | number | The tax amount applied for shipping of the invoice products |
| shippingTaxCode | string | The default tax code applied for the shipping of the invoice products |
| shippingTaxRate | string | The default tax rate applied for the shipping of the invoice products |
| revRecEndDate | date | Revenue recognition end date |
| revRecStartDate | date | Revenue recognition start date |
| handlingCost | number | The inventory cost incurred for handling the products of the invoice |
| handlingTaxCode | string | The default tax code applied for the inventory handling of the invoice products |
| handlingTaxRate | string | The default tax rate applied for the inventory handling of the invoice products |
- 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 in this line |
| lines[*].product.name | string | The name of the product in this line |
| lines[*].salesUom | string | The sales unit of measure of the product |
| lines[*].quantity | number | Number of units of product provided. |
| lines[*].subTotal | number | The total amount of the line excluding taxes |
| lines[*].taxAmount | number | Amount of tax for the line. |
| lines[*].taxCode | string | The applicable tax code pertaining to the line |
| lines[*].taxName | string | The applicable tax description pertaining to the line |
| lines[*].account | string | The applicable General ledger account where the line is recorded |
| lines[*].taxRate | string | The percentage of tax applicable to the line item |
| lines[*].totalAmount | number | The total amount of the line including taxes |
| lines[*].discountAmount | number | Numerical value of any discounts applied for the line |
| lines[*].discountRate | string | The total discount rate applied for the line |
| lines[*].id | string | The unique identifier of the line in the invoice |
| lines[*].isTaxable | boolean | Indicator whether the line is taxable or not |
- billingAddress
| billingAddress.city | string | City of customer's billing address |
| billingAddress.country | string | Country of customer's billing address |
| billingAddress.id | string | Identifier of customer's billing address in accounting system |
| billingAddress.line1 | string | Address line1 of customer's billing address |
| billingAddress.line2 | string | Address line2 of customer's billing address |
| billingAddress.phone | string | Phone number of customer's billing address |
| billingAddress.postalCode | string | Postal code of customer's billing address |
| billingAddress.province | string | Province of customer's billing address |
| billingAddress.contact.firstName | string | First name of contact at customer's billing address |
| billingAddress.contact.middleName | string | Middle name of contact at customer's billing address |
| billingAddress.contact.lastName | string | Last name of contact at customer's billing address |
| billingAddress.contact.salutation | string | Salutation / Title of contact at customer's billing address |
| billingAddress.contact.email | string | Email of contact at customer's billing address |
- shippingAddress
| shippingAddress.city | string | City of customer's shipping address |
| shippingAddress.country | string | Country of customer's shipping address |
| shippingAddress.id | string | Identifier of customer's shipping address in accounting system |
| shippingAddress.line1 | string | Address line1 of customer's shipping address |
| shippingAddress.line2 | string | Address line2 of customer's shipping address |
| shippingAddress.phone | string | Phone number of customer's shipping address |
| shippingAddress.postalCode | string | Postal code of customer's shipping address |
| shippingAddress.province | string | Province of customer's shipping address |
| shippingAddress.contact.firstName | string | First name of contact at customer's shipping address |
| shippingAddress.contact.middleName | string | Middle name of contact at customer's shipping address |
| shippingAddress.contact.lastName | string | Last name of contact at customer's shipping address |
| shippingAddress.contact.salutation | string | Salutation of contact at customer's shipping address |
| shippingAddress.contact.email | string | Email of contact at customer's shipping address |
- paymentTerms
| paymentTerms.id | string | Identifier of the payment terms. |
| paymentTerms.name | string | Name of the payment terms. |
- customer
| customer.id | string | Identifier of the customer |
| customer.name | string | Name of the customer |
| customer.contact.address.city | string | The customer contact person’s city |
| customer.contact.address.country | string | The customer contact person’s country |
| customer.contact.address.line1 | string | The customer contact person’s Address Line 1 |
| customer.contact.address.line2 | string | The customer contact person’s Address Line 2 |
| customer.contact.address.postalCode | string | The customer contact person’s Postal Code |
| customer.contact.address.province | string | The customer contact person’s Province |
| customer.contact.email | string | The customer contact person’s email |
| customer.contact.firstName | string | The customer contact person’s First name |
| customer.contact.lastName | string | The customer contact person’s Last name |
| customer.contact.middleName | string | The customer contact person’s Middle name |
| customer.contact.mobile | string | The customer contact person’s mobile |
| customer.contact.phone | string | The customer contact person’s phone number |
- 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[*].lines[*].amount | number | Amount paid(in the currency of the invoice) for this particular invoice |
| payment[*].lines[*].id | string | Unique payment line identifier |
| payment[*].currency | string | Currency of the payment amount |
| payment[*].paymentDate | date | The date of the payment made |
| payment[*].exchangeRate | number | The exchange rate used by the accounting for the payment amount to convert into local currency |
