Link

Invoice Operations

The following parameters are required to create or update an Invoice

Invoice FieldTypeValid forDescription
InvoiceNumberStringAllInvoice - Unique alphanumeric code identifying invoice ( when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) Bill - non-unique alphanumeric code identifying invoice. This value will also display as Reference in the UI. (max length = 255)
ReferenceStringAllInvoice only - additional reference number (max length = 255)
BrandingThemeIDStringAllBranding Theme Id or value (max length = 255)
CurrencyCodeStringAllThe currency that invoice has been raised in
InvoiceDateDateInvoice, BillDate invoice was issued - YYYY-MM-DD. If the Date element is not specified, it will default to the current date based on the timezone setting of the organisation
InvoiceIdStringInvoice/BillXero generated unique identifier for Invoice/Bill, Required while updating
DueDateStringInvoice, BillDate invoice is due - YYYY-MM-DD
ClientId *StringAllXero generated unique identifier for Xero Contact (Xero Id)
LineItemsLineItemWrapperAllSee LineItems. The LineItems collection can contain any number of individual LineItem sub-elements.
AttentionToStringPurchase OrderThe person that the delivery is going to
DeliveryAddressStringPurchase OrderThe address the goods are to be delivered to
DeliveryInstructionsStringPurchase OrderA free text field for instructions (500 characters max)
TelephoneStringPurchase OrderThe phone number for the person accepting the delivery
PurchaseOrderIDStringPurchase OrderXero generated unique identifier for a purchase order, Required while updating
PurchaseOrderNumberStringPurchase OrderLast name of contact person (max length = 255)
DeliveryDateStringPurchase OrderDate the goods are to be delivered - YYYY-MM-DD
PurchaseOrderDateStringPurchase OrderDate purchase order was issued - YYYY-MM-DD. If the Date element is not specified, then it will default to the current date based on the timezone setting of the organisation

Line Item Fields

LineItemWrapper FieldTypeValid forDescription
ItemCodeStringAllXero generated identifier for an item
Description *StringAllThe sales description of the item, Line Items must have a Description
TaxTypeStringAllUsed as an override if the default Tax Code for the selected AccountCode is not correct
AccountCodeStringAllDefault account code to be used for purchased/sale. Not applicable to the purchase details of tracked items
LineItemIDStringAllXero generated unique Id
UnitAmountDecimalAllUnit Price of the item. By default, UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 query string parameter to your request.
TaxAmountDecimalAllTax amount of invoice
LineAmountDecimalAllLine Amount of invoice
QuantityDecimalAllThe quantity of the item on hand
DiscountRateDecimalInvoice, Purchase OrderThe Discount rate of the item
TrackingTrackingItemWrapperAllTrackingItemWrapper type

TrackingItemWrapper Fields

TrackingItemWrapper FieldTypeDescription
NameStringThe name of the tracking category (max length = 100)
OptionString 
TrackingCategoryIDStringThe Xero identifier for a tracking category

Table of contents