Product Invoices

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.

FieldTypeDescription
amountnumberAmount of the invoice, inclusive of tax.
currencystringCurrency of the invoice.
idstringIdentifier for the invoice, unique to the company in the accounting platform.
linesarrayAn array of invoice line items.
billingAddressobjectAn object of billing address
invoiceDatedateDate of the invoice as recorded in the accounting system.
dueDatedateDate the customer is due to be paid by.
modifiedDatedateDate the record was last updated in the accounting system.
paymentTermsobjectAn object of Payment Terms applied to the invoice
customerobjectAn object of customer associated with the invoice
createdDatedateDate the record was created in the accounting system.
departmentobjectAn object of department for which the products have been ordered.
externalIdstringFriendly reference of the invoice/reference of invoice from an external system
locationobjectAn object of location for which the products have been ordered.
paymentarrayAn array of payment details pertaining to the invoice
statusstringCurrent status of the invoice
taxAmountnumberTotal tax amount against the invoice
taxCodestringDefault tax code applied to the invoice.
taxNamestringThe tax description of the default tax to be applied to the invoice.
taxRatestringDefault tax rate applied to the invoice
descriptionstringThe description / reference / notes associated with the invoice
discountDatedateThe date of discount recorded in the accounting system for the invoice
parentDocumentNumberstringCustomer purchase order/Sales order associated with this invoice
totalAmountDuenumberTotal amount that is due on the invoice
totalAmountPaidnumberTotal amount that is paid on the invoice
discountAmountnumberNumerical value of discounts applied to the invoice.
discountRatestringApplied discount rate on the invoice
glPostDatedateThe date of posting of the transaction in the accounting system (General Ledger)
accountstringThe General Ledger account in which the transaction is posted
languagestringDefault language code used by the customer
exchangeRatenumberRate between the currency of the invoice and the base currency.
subTotalnumberThe total amount of invoice excluding taxes
fullPaymentDatedateDate the invoice was marked as paid in the accounting system
shippingAddressobjectAn object of shipping address
shippingCostnumberThe cost incurred for shipping in the invoice
shippingMethodstringThe shipping method and terms used for the products in the invoice
shippingTaxAmountnumberThe tax amount applied for shipping of the invoice products
shippingTaxCodestringThe default tax code applied for the shipping of the invoice products
shippingTaxRatestringThe default tax rate applied for the shipping of the invoice products
revRecEndDatedateRevenue recognition end date
revRecStartDatedateRevenue recognition start date
handlingCostnumberThe inventory cost incurred for handling the products of the invoice
handlingTaxCodestringThe default tax code applied for the inventory handling of the invoice products
handlingTaxRatestringThe default tax rate applied for the inventory handling of the invoice products
  • lines
lines[*].department.idstringThe unique id of the department for which the product has been ordered.
lines[*].department.namestringThe name of the department for which the product has been ordered.
lines[*].descriptionstringThe description / notes pertaining to the product
lines[*].location.idstringThe unique id of the location for which the product has been ordered.
lines[*].location.namestringThe name of the location for which the product has been ordered.
lines[*].product.costnumberThe unit cost of the product
lines[*].product.idstringThe unique identifier of the product in this line
lines[*].product.namestringThe name of the product in this line
lines[*].salesUomstringThe sales unit of measure of the product
lines[*].quantitynumberNumber of units of product provided.
lines[*].subTotalnumberThe total amount of the line excluding taxes
lines[*].taxAmountnumberAmount of tax for the line.
lines[*].taxCodestringThe applicable tax code pertaining to the line
lines[*].taxNamestringThe applicable tax description pertaining to the line
lines[*].accountstringThe applicable General ledger account where the line is recorded
lines[*].taxRatestringThe percentage of tax applicable to the line item
lines[*].totalAmountnumberThe total amount of the line including taxes
lines[*].discountAmountnumberNumerical value of any discounts applied for the line
lines[*].discountRatestringThe total discount rate applied for the line
lines[*].idstringThe unique identifier of the line in the invoice
lines[*].isTaxablebooleanIndicator whether the line is taxable or not
  • billingAddress
billingAddress.citystringCity of customer's billing address
billingAddress.countrystringCountry of customer's billing address
billingAddress.idstringIdentifier of customer's billing address in accounting system
billingAddress.line1stringAddress line1 of customer's billing address
billingAddress.line2stringAddress line2 of customer's billing address
billingAddress.phonestringPhone number of customer's billing address
billingAddress.postalCodestringPostal code of customer's billing address
billingAddress.provincestringProvince of customer's billing address
billingAddress.contact.firstNamestringFirst name of contact at customer's billing address
billingAddress.contact.middleNamestringMiddle name of contact at customer's billing address
billingAddress.contact.lastNamestringLast name of contact at customer's billing address
billingAddress.contact.salutationstringSalutation / Title of contact at customer's billing address
billingAddress.contact.emailstringEmail of contact at customer's billing address
  • shippingAddress
shippingAddress.citystringCity of customer's shipping address
shippingAddress.countrystringCountry of customer's shipping address
shippingAddress.idstringIdentifier of customer's shipping address in accounting system
shippingAddress.line1stringAddress line1 of customer's shipping address
shippingAddress.line2stringAddress line2 of customer's shipping address
shippingAddress.phonestringPhone number of customer's shipping address
shippingAddress.postalCodestringPostal code of customer's shipping address
shippingAddress.provincestringProvince of customer's shipping address
shippingAddress.contact.firstNamestringFirst name of contact at customer's shipping address
shippingAddress.contact.middleNamestringMiddle name of contact at customer's shipping address
shippingAddress.contact.lastNamestringLast name of contact at customer's shipping address
shippingAddress.contact.salutationstringSalutation of contact at customer's shipping address
shippingAddress.contact.emailstringEmail of contact at customer's shipping address
  • paymentTerms
paymentTerms.idstringIdentifier of the payment terms.
paymentTerms.namestringName of the payment terms.
  • customer
customer.idstringIdentifier of the customer
customer.namestringName of the customer
customer.contact.address.citystringThe customer contact person’s city
customer.contact.address.countrystringThe customer contact person’s country
customer.contact.address.line1stringThe customer contact person’s Address Line 1
customer.contact.address.line2stringThe customer contact person’s Address Line 2
customer.contact.address.postalCodestringThe customer contact person’s Postal Code
customer.contact.address.provincestringThe customer contact person’s Province
customer.contact.emailstringThe customer contact person’s email
customer.contact.firstNamestringThe customer contact person’s First name
customer.contact.lastNamestringThe customer contact person’s Last name
customer.contact.middleNamestringThe customer contact person’s Middle name
customer.contact.mobilestringThe customer contact person’s mobile
customer.contact.phonestringThe customer contact person’s phone number
  • department
department.idstringIdentifier of the department
department.namestringName of the department
  • location
location.idstringIdentifier of the location
location.namestringName of the location
  • payment
payment[*].idstringIdentifier of the payment
payment[*].lines[*].amountnumberAmount paid(in the currency of the invoice) for this particular invoice
payment[*].lines[*].idstringUnique payment line identifier
payment[*].currencystringCurrency of the payment amount
payment[*].paymentDatedateThe date of the payment made
payment[*].exchangeRatenumberThe exchange rate used by the accounting for the payment amount to convert into local currency