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.
| Field | Type | Description |
| amount | number | Amount of the sales order, inclusive of tax. |
| currency | string | Currency of the sales order |
| id | string | Identifier for the sales order, unique to the sales order in the accounting platform. |
| lines | array | An array of sales order line items. |
| billingAddress | object | An object of billing address |
| salesOrderDate | date | Date of the sales order as recorded in the accounting system. |
| isTaxable | boolean | The indicator which shows whether the amount and items are taxable or not |
| dueDate | date | Date when the payment of the sales order is due |
| modifiedDate | date | Date the record was last updated in the accounting system. |
| paymentTerms | object | An object of Payment Terms applicable to the sales order |
| customer | object | An object of customer associated with the sales order |
| createdDate | date | Date the record was created in the accounting system. |
| department | object | An object of department for which the products have |
| externalId | string | Friendly reference of the sales order/reference of sales order from an external system |
| payment | array | An array of payment details pertaining to this sales order |
| status | string | Current status of the sales order transaction |
| taxAmount | number | Amount of tax on the sales order. |
| taxCode | string | Default tax code applied to the sales order. |
| taxRate | string | Default tax rate applied to the sales order |
| description | string | The description / reference / notes associated with the sales order |
| customerPONumber | string | Customer purchase order associated with this sales order |
| totalOutstandingAmount | number | Total amount that is outstanding on the sales order |
| exchangeRate | number | Rate between the currency of the invoice and the base currency |
| subTotal | number | Total amount of the invoice excluding any taxes. |
| shippingAddress | object | An object of shipping address |
| shippingCost | number | The cost incurred for shipping in the sales order |
| requestedShipDate | date | The requested date of delivery of the items in the sales order |
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 item |
| 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 department for which the product has been ordered. |
| lines[*].priceLevel.price | 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[*].product.salesUom | string | The sales unit of measure of the product |
| lines[*].orderQuantity | number | The ordered quantity of the product in the sales order |
| lines[*].subTotal | number | Amount of the line excluding taxes |
| lines[*].taxAmount | number | The total tax amount of the line |
| lines[*].taxCode | string | The applied tax code pertaining to the line item |
| lines[*].taxRate | string | The percentage of tax applied to the line item |
| lines[*].totalAmount | number | The total amount of the line including taxes |
| lines[*].discountAmount | number | Numerical value of any discounts applied. |
| lines[*].id | string | The unique identifier of the line in the sales order |
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 / Title 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 |
