PurchaseOrders
Table Specific Information
Name
Type
ReadOnly
Description
Id [KEY]
String
True
The line item index combined with the Id of the purchase order.
PurchaseOrderId
String
False
The Id of the purchase order.
PurchaseOrderNumber
String
False
A unique identifier for the purchase order that identifies it to the user.
Reference
String
False
An optional field to store a reference.
Type
String
False
The purchase order type. The valid values are ACCPAYCREDIT and ACCRECCREDIT.
Contact_ContactId
String
False
The Id of the contact.
Contact_Name
String
False
The name of the contact.
DeliveryDate
Date
False
The date the purchase order is to be delivered.
ExpectedArrivalDate
Date
False
The date the purchase is expected to arrive.
DeliveryAddress
String
False
The address the goods are to be delivered to.
AttentionTo
String
False
The person the delivery is going to.
Telephone
String
False
The phone number of the person accepting the delivery.
DeliveryInstructions
String
False
Free-form field for information needed to complete the delivery.
Date
Date
False
The date the purchase order was created.
Status
String
False
The status of the purchase order.
LineAmountTypes
String
False
The line amount type, which determines whether line amounts include tax (default). The valid values are Exclusive, Inclusive, and NoTax. Purchase orders cannot be approved without this field being defined.
LineItem_LineItemId
String
False
The Xero generated identifier for a LineItem. If LineItemIDs are not included with line items in an update request then the line items are deleted and recreated.
LineItem_Description
String
False
The description for the line item of the purchase order. This value must be at least one character. Invoices cannot be approved without these fields.
LineItem_Quantity
Double
False
The quantity of the subject of the line item. This value must be greater than or equal to 0. Invoices cannot be approved without these fields.
LineItem_UnitAmount
Decimal
False
The unit amount of the subject of the line item. Invoices cannot be approved without these fields.
LineItem_ItemCode
String
False
The user-defined item code.
LineItem_AccountCode
String
False
The account code. The account code must be active for the organisation. Invoices cannot be approved without these fields.
LineItem_TaxType
String
False
The description for the line item of the purchase order. This value must be at least one character. Invoices cannot be approved without these fields.
LineItem_TaxAmount
Decimal
False
The quantity of the subject of the line item. This value must be greater than or equal to 0. Invoices cannot be approved without these fields.
LineItem_LineAmount
Decimal
False
The total of the Quantity field multiplied by the UnitAmount field with discounts applied.
LineItem_DiscountRate
Double
False
The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type purchase orders.
LineItemAggregate
String
False
Used to define LineItem rows using XML values. Should be provided on INSERT only.
SubTotal
Decimal
False
The subtotal of the purchase order, excluding taxes.
TotalTax
Decimal
False
The total tax on the purchase order.
Total
Decimal
False
The total of the purchase order (the subtotal plus the total tax).
LineItem_TrackingCategory1_CategoryId
String
False
The Id of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory1_CategoryName
String
False
The name of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory1_OptionId
String
False
The Id of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory1_OptionName
String
False
The option of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory1_Option_Stat
String
False
The status of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory2_CategoryId
String
False
The Id of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory2_CategoryName
String
False
The name of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory2_OptionId
String
False
The Id of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory2_OptionName
String
False
The option of a tracking category. The API allows two optional tracking categories to be defined.
LineItem_TrackingCategory2_Option_Stat
String
False
The status of a tracking category. The API allows two optional tracking categories to be defined.
UpdatedDateUTC
Datetime
True
The date when the purchase order was last updated.
HasAttachments
Boolean
True
Indicates if the PurchaseOrder has a file attached.
CurrencyCode
String
False
The currency used for the purchase order.
BrandingThemeId
String
False
The Id of the branding theme.
CurrencyRate
Decimal
False
Exchange rate to base currency when money is spent or received. For example, 0.7500. This field is used for only bank transactions not in the base currency. If this is not specified for non-base-currency accounts then either the user-defined rate or the XE.com daily rate will be used.
TenantId
String
False
The ID of the tenant to query instead of the connection tenant
Last updated