Sales Orders

Sales Orders
A sales order is a commercial document and the first official offer received by a supplier/vendor indicating types and agreed prices for the product or service.

FieldTypeDescription
amountnumberAmount of the sales order, inclusive of tax.
currencystringCurrency of the sales order
idstringIdentifier for the sales order, unique to the sales order in the accounting platform.
linesarrayAn array of sales order line items.
billingAddressobjectAn object of billing address
salesOrderDatedateDate of the sales order as recorded in the accounting system.
isTaxablebooleanThe indicator which shows whether the amount and items are taxable or not
dueDatedateDate when the payment of the sales order is due
modifiedDatedateDate the record was last updated in the accounting system.
paymentTermsobjectAn object of Payment Terms applicable to the sales order
customerobjectAn object of customer associated with the sales order
createdDatedateDate the record was created in the accounting system.
departmentobjectAn object of department for which the products have 
externalIdstringFriendly reference of the sales order/reference of sales order from an external system
paymentarrayAn array of payment details pertaining to this sales order
statusstringCurrent status of the sales order transaction
taxAmountnumberAmount of tax on the sales order.
taxCodestringDefault tax code applied to the sales order.
taxRatestringDefault tax rate applied to the sales order
descriptionstringThe description / reference / notes associated with the sales order
customerPONumberstringCustomer purchase order associated with this sales order
totalOutstandingAmountnumberTotal amount that is outstanding on the sales order
exchangeRatenumberRate between the currency of the invoice and the base currency
subTotalnumberTotal amount of the invoice excluding any taxes.
shippingAddressobjectAn object of shipping address
shippingCostnumberThe cost incurred for shipping in the sales order
requestedShipDatedateThe requested date of delivery of the items in the sales order

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 item
lines[*].location.idstringThe unique id of the location for which the product has been ordered.
lines[*].location.namestringThe name of the department for which the product has been ordered.
lines[*].priceLevel.pricenumberThe 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[*].product.salesUomstringThe sales unit of measure of the product
lines[*].orderQuantitynumberThe ordered quantity of the product in the sales order
lines[*].subTotalnumberAmount of the line excluding taxes
lines[*].taxAmountnumberThe total tax amount of the line
lines[*].taxCodestringThe applied tax code pertaining to the line item
lines[*].taxRatestringThe percentage of tax applied to the line item
lines[*].totalAmountnumberThe total amount of the line including taxes
lines[*].discountAmountnumberNumerical value of any discounts applied.
lines[*].idstringThe unique identifier of the line in the sales order

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 / Title of contact at customer's shipping address
shippingAddress.contact.email stringEmail 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