Purchase Orders

The Purchase Order Object

A purchase order is a commercial document and the first official offer issued by a buyer to a seller indicating types, quantities, and agreed prices for products or services. From the Purchase Ordes endpoint, you can retrieve a list of all purchase orders for a specified business.

FieldTypeDescription
idstring Identifier for the purchase order, unique to the business in the accounting service provider.
vendorRefReference TypesReference to the vendor the purchase order has been issued to.
accountRefReference TypesReference to the account to which the purchase order is linked to.
postedDate
sortable, filterable
string
See Date
Date of the purchase order as recorded in the accounting service provider.
dueDate
sortable, filterable
string
See Date
Date the purchase order is due to be paid by.
deliveryDate
sortable, filterable
string
See Date
Date the purchase order expired as recorded in the accounting service provider.
expectedArrivalDate
sortable, filterable
string
See Date
Date the purchase order was accepted by the vendor as recorded in the accounting service provider.
currencyRef Reference TypesCurrency of the purchase order.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.
currencyRate decimalRate between the currency of the purchase order and the base currency of the business. Not applicable when multi-currency is not supported.
lines arrayAn array of purchase order lines.
subTotal
sortable, filterable
decimalValue of the purchase order, including discounts and excluding tax.
taxAmount
sortable, filterable
decimalAny tax applied to the purchase order amount.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
totalAmount
sortable, filterable
decimalAmount of the purchase order, inclusive of tax.
status
sortable, filterable
stringCurrent status of a purchase order.
memo stringUser-friendly reference for the purchase order.
shippingAddressReference TypesDelivery for any goods that have been ordered.
contactReference TypesDetails of the named contact at the delivery address.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

Lines

FieldTypeDescription
description string Friendly name of the goods or services received.
unitAmount decimal Price of each unit of goods or services.
quantity integerNumber of units of goods or services.
discountAmount decimalNumerical value of any discounts applied.
discountPercentage decimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
subTotal decimalAmount of the line, inclusive of discounts but exclusive of tax.
taxAmount decimalAmount of tax for the line.
totalAmount decimalTotal amount of the line, inclusive of discounts and tax.
accountRef Reference TypesReference to the account to which the line item is linked to.
taxRateRef Reference TypesReference to the tax rate to which the line item is linked to.

When pushing data, a valid tax rate reference must be used by querying Tax Rates and using the id parameter as a value. For Xero, use code parameter as a value.
inventoryRefReference TypesReference to the product or inventory item to which the line item is linked to.

When pushing data, a valid inventory item reference must be used by querying Inventory and using the id parameter as a value. For Xero, use code parameter as a value.
trackingCategoryRefReference TypesReference to the tracking category to which the line item is linked to.

Purchase Order Status

  • open - Purchase Order is no longer a draft. It has been processed and/or sent to the customer. In this state, it will impact the ledger.
  • closed - Purchase Order has been closed.
  • void - A Purchase Order can become void by being deleted, refunded, written off, or cancelled.
  • draft - Purchase Order is yet to be authorized and sent to the customer, and will not be used in any reports. It may contain incomplete line items.
  • unknown - Railz was not able to recognize the status of the purchase order. This can be due to missing values in the accounting service provider or unavailable in the data we received.