Product Purchase Orders

Product Purchase Orders
A purchase order is a commercial document and first official offer issued by a customer indicating types, quantities, and agreed prices for products.

FieldTypeDescription
amountnumberAmount of the purchase order, inclusive of tax.
currencystringCurrency of the purchase order.
idstringIdentifier for the purchase order, unique to the purchase order in the accounting platform.
linesarrayAn array of purchase order lines
billingAddressobjectAn object of billing address
purchaseOrderDatedateDate of the invoice as recorded in the accounting system.
dueDatedateDate the purchase order is due to be paid by.
modifiedDatedateDate the record was last updated in the accounting system.
paymentTermsobjectAn object of Payment Terms applicable to the purchase order
vendorobjectAn object of vendor associated with the purchase order
createdDatedateDate the record was created in the accounting system.
billarrayAn array of bills associated with this purchase order
externalIdstringFriendly reference of the purchase order/reference of purchase order from an external system
statusstringCurrent status of this purchase order
taxAmountnumberAmount of tax on the purchase order.
taxCodestringDefault tax code applied to the purchase order.
descriptionstringThe description / reference / notes associated with the purchase order
totalAmountDuenumberTotal amount that is due on the purchase order
totalAmountPaidnumberTotal amount that is paid on that purchase order
glPostDatedateThe date of posting of this transaction in the accounting system (General Ledger)
accountstringThe General Ledger account in which this transaction is posted
exchangeRatenumberRate between the currency of the purchase order and the base currency.
subTotalnumberTotal amount of the purchase order excluding any taxes.
shippingAddressobjectAn object of shipping address
shippingMethodstringThe shipping method and terms used for the products in the purchase order
creditLimitnumberCurrent credit limit available from the vendor.
shipDatedateThe expected delivery date of the products in purchase 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 location for which the product has been ordered.
lines[*].product.costnumberThe unit cost of the product in the line
lines[*].product.idstringThe unique identifier of the product in the line
lines[*].product.namestringThe name of the product in the line
lines[*].customer.idstringThe unique identifier of the customer for whom the product is being procured.
lines[*].customer.namestringThe name of the customer for whom the product is being procured.
lines[*].product.purchaseUomstringThe purchase unit of measure of the product
lines[*].orderedQuantitynumberThe ordered quantity of the product in the purchase order
lines[*].subTotalnumberAmount of the line, inclusive of discounts but exclusive of tax.
lines[*].taxAmountnumberThe total tax amount of the line
lines[*].taxCodestringThe applied tax code pertaining to the line
lines[*].taxNamestringThe applied tax description pertaining to the line
lines[*].accountstringThe applicable General ledger account where the line is recorded
lines[*].taxRatestringThe percentage of tax applied to the line
lines[*].totalAmountnumberThe total amount of the line including taxes
lines[*].discountAmountnumberNumerical value of any discounts applied.
lines[*].discountRatestringThe total discount rate applied on this line
lines[*].idstringThe unique identifier of the line in the purchase order
lines[*].isTaxablebooleanIndicator whether the line is taxable or not
  • billingAddress
billingAddress.citystringCity of supplier's billing address
billingAddress.countrystringCountry of supplier's billing address
billingAddress.idstringIdentifier of supplier's billing address in accounting system
billingAddress.line1stringAddress line1 of supplier's billing address
billingAddress.line2stringAddress line2 of supplier's billing address
billingAddress.phonestringPhone number of supplier's billing address
billingAddress.postalCodestringPostal code of supplier's billing address
billingAddress.provincestringProvince of supplier's billing address
billingAddress.contact.firstNamestringFirst name of contact at supplier's billing address
billingAddress.contact.middleNamestringMiddle name of contact at supplier's billing address
billingAddress.contact.lastNamestringLast name of contact at supplier's billing address
billingAddress.contact.salutationstringSalutation / Title of contact at supplier's billing address
billingAddress.contact.emailstringEmail of contact at supplier's billing address
  • shippingAddress
shippingAddress.citystringCity of supplier's shipping address
shippingAddress.countrystringCountry of supplier's shipping address
shippingAddress.idstringIdentifier of supplier's shipping address in accounting system
shippingAddress.line1stringAddress line1 of supplier's shipping address
shippingAddress.line2stringAddress line2 of supplier's shipping address
shippingAddress.phonestringPhone number of supplier's shipping address
shippingAddress.postalCodestringPostal code of supplier's shipping address
shippingAddress.provincestringProvince of supplier's shipping address
shippingAddress.contact.firstNamestringFirst name of contact at supplier's shipping address
shippingAddress.contact.middleNamestringMiddle name of contact at supplier's shipping address
shippingAddress.contact.lastNamestringLast name of contact at supplier's shipping address
shippingAddress.contact.salutationstringSalutation / Title of contact at supplier's shipping address
shippingAddress.contact.emailstringEmail of contact at supplier's shipping address
  • paymentTerms
paymentTerms.idstringIdentifier of the payment terms.
paymentTerms.namestringName of the payment terms.
  • vendor
vendor.idstringIdentifier of the vendor
vendor.namestringName of the vendor
vendor.contact.address.citystringThe vendor contact person’s city
vendor.contact.address.countrystringThe vendor contact person’s country
vendor.contact.address.line1stringThe vendor contact person’s Address Line 1
vendor.contact.address.line2stringThe vendor contact person’s Address Line 2
vendor.contact.address.postalCodestringThe vendor contact person’s Postal Code
vendor.contact.address.provincestringThe vendor contact person’s Province
vendor.contact.emailstringThe vendor contact person’s email
vendor.contact.firstNamestringThe vendor contact person’s First name
vendor.contact.lastNamestringThe vendor contact person’s Last name
vendor.contact.middleNamestringThe vendor contact person’s Middle name
vendor.contact.mobilestringThe vendor contact person’s mobile
vendor.contact.phonestringThe vendor contact person’s phone number
  • bill
bill[*].idstringUnique Identifier of the bill