Xero Accounting Endpoint: PurchaseOrders

Overview

The Xero PurchaseOrders endpoint provides the list of purchase orders recorded within Xero.

Fields

The following fields are available for the PurchaseOrders endpoint.

PurchaseOrderID: A guid field that provides the id of the purchase order.

PurchaseOrderNumber: A text field that provides the purchase order number.

Type: A text field that indicates the type of purchase order. This is set to PURCHASEORDER.

Reference: A text field that provides the reference of the purchase order.

Status

A text field that indicates the status of the purchase order.

Possible values are:

DRAFT: Indicates the purchase order is a draft.
SUBMITTED: Indicates the purchase order is awaiting approval.
AUTHORISED: Indicates the purchase order is approved.
BILLED: Indicates the purchase order has been converted to a purchase invoice.
DELETED: Indicates the purchase order is deleted.

Date: A date field that provides the date on which the purchase order occurred.

DeliveryDate: A date field that provides the delivery date of the purchase order.

ExpectedArrivalDate: A date field that provides the expected arrival date of the goods on the purchasde order.

Contact: A record field that provides the Contacts associated with the invoice.

DeliveryAddress: A text field that provides the delivery address on the purchase order.

AttentionTo: A text field that provides the name of the recipient on the purchase order.

Telephone: A text field that provides the telephone number of the recipient on the purchase order.

DeliveryInstructions: A text field that provides the delivery instructions of the purchase order.

SentToContact: A true/false field that indicates if the purchase order has been sent to the contact.

LineAmountTypes

A text field that indicates the type of values on the lines.

Possible values are:

Exclusive: Indicates that line items are exclusive of tax.
Inclusive: Indicates that line items are inclusive tax.
NoTax: Indicates that line items have no tax.

LineItems: A table field that provides the purchase order lines.; See LineItems Fields for more information.

Subtotal: A decimal field that provides the tax exclusive amount of the transaction.

TotalTax: A decimal field that provides the tax amount of the transaction.

Total: A decimal field that provides the total amount of the transaction.

CurrencyCode: A text field that indicates the currency of the transaction.

CurrencyRate: A decimal field that provides the exchange rate applied to the transaction.

BrandingThemeID: A guid field that indicates the branding theme of the invoice.

HasAttachments: A true/false field that indicates if attachments were uploaded against the transaction.

UpdatedDateUTC: A date time field that indicates the date and time this invoice was created and/or updated.

LineItems Fields

The LineItems Fields include the following sub fields.

LineItemID: A guid field that provides an ID for the line.

Description: A text field that provides the description of the line.

Quantity: A decimal field that provides the quantity of the line.

UnitAmount: A decimal field that provides the unit amount of the line.

LineAmount: A decimal field that provides the amount of the line.

TaxAmount: A decimal field that provides the tax amount of the line.

DiscountRate: A decimal field that provides the discount rate applied to the line.

AccountCode: A text field that provides the account code of the line.

ItemCode: A text field that provides the item code of the line.

TaxType: A text field that provides the tax type of the line.

Tracking: A table field that provides the tracking category options assigned to the line.

Xero API

For a detailed run through of the endpoint, you can see the Xero API.

Related Fields

Contacts

TaxTypes

TrackingCategories

Related Endpoints