Xero: Accounting schemas (part 2)

← Accounting operations · All schemas

Deletes an Allocation from a Prepayment — response body

Field	Type	Presence	Description and constraints
$	object	Root
AllocationID	string	Optional	Xero generated unique identifier Format: uuid
Amount	JSON	Required within parent
Amount (anyOf 1)	number	Alternative	the amount being applied to the invoice Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CreditNote	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Credit Note
Date	string	Required within parent	the date the allocation is applied YYYY-MM-DD.
Invoice	Model	Required within parent	Expand Deletes an Allocation from a Prepayment — response body — Invoice
IsDeleted	boolean	Optional	A flag that returns true when the allocation is succesfully deleted Read only: true
Overpayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Overpayment
Prepayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Prepayment
StatusAttributeString	string	Optional	A string to indicate if a invoice status
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Credit Note, Deletes an Allocation from a Prepayment — response body — Invoice, Deletes an Allocation from a Prepayment — response body — Overpayment, Deletes an Allocation from a Prepayment — response body — Prepayment, Retrieves journals — response body — Warnings item

Deletes an Allocation from a Prepayment — response body — Credit Note

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body
AppliedAmount	JSON	Optional
AppliedAmount (anyOf 1)	number	Alternative	The amount of applied to an invoice Format: double
AppliedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
CISDeduction	JSON	Optional
CISDeduction (anyOf 1)	number	Alternative	CIS deduction for UK contractors Format: double Read only: true
CISDeduction (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CISRate	JSON	Optional
CISRate (anyOf 1)	number	Alternative	CIS Deduction rate for the organisation Format: double Read only: true
CISRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CreditNoteID	string	Optional	Xero generated unique identifier Format: uuid
CreditNoteNumber	string	Optional	ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code The specified currency code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	The date the credit note is 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
DueDate	string	Optional	Date invoice is due – YYYY-MM-DD
FullyPaidOnDate	string	Optional	Date when credit note was fully paid(UTC format)
HasAttachments	boolean	Optional	boolean to indicate if a credit note has an attachment Default: false
HasErrors	boolean	Optional	A boolean to indicate if a credit note has an validation errors Default: false
InvoiceAddresses	array	Optional	An array of addresses used to auto calculate sales tax
InvoiceAddresses[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Invoice Line Items
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
Reference	string	Optional	ACCRECCREDIT only – additional reference number
RemainingCredit	JSON	Optional
RemainingCredit (anyOf 1)	number	Alternative	The remaining credit balance on the Credit Note Format: double
RemainingCredit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SentToContact	boolean	Optional	Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved
Status	string	Optional	See Credit Note Status Codes Known values: DRAFT, SUBMITTED, DELETED, AUTHORISED, PAID, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	The subtotal of the credit note excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	The total of the Credit Note(subtotal + total tax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	The total tax on the credit note Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Credit Note Types Known values: ACCPAYCREDIT, ACCRECCREDIT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the credit note Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the credit note Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Deletes an Allocation from a Prepayment — response body, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves payments for invoices and credit notes — response body — Payments item, Retrieves journals — response body — Warnings item

Deletes an Allocation from a Prepayment — response body — Invoice

Field	Type	Presence	Description and constraints
$	object	Root
AmountCredited	JSON	Optional
AmountCredited (anyOf 1)	number	Alternative	Sum of all credit notes, over-payments and pre-payments applied to invoice Format: double Read only: true
AmountCredited (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AmountDue	JSON	Optional
AmountDue (anyOf 1)	number	Alternative	Amount remaining to be paid on invoice Format: double Read only: true
AmountDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AmountPaid	JSON	Optional
AmountPaid (anyOf 1)	number	Alternative	Sum of payments received for invoice Format: double Read only: true
AmountPaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
CISDeduction	JSON	Optional
CISDeduction (anyOf 1)	number	Alternative	CIS deduction for UK contractors Format: double Read only: true
CISDeduction (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CISRate	JSON	Optional
CISRate (anyOf 1)	number	Alternative	CIS Deduction rate for the organisation Format: double Read only: true
CISRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CreditNotes	array	Optional	Details of credit notes that have been applied to an invoice Read only: true
CreditNotes[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Credit Note
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date 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
DueDate	string	Optional	Date invoice is due – YYYY-MM-DD
EnteredTotal	JSON	Optional
EnteredTotal (anyOf 1)	number	Alternative	The total amount as originally entered for the invoice, before any RoundingAmount adjustment is applied. Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Can only be set while the invoice is DRAFT; once the invoice is no longer DRAFT this reflects Total. This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET) Format: double
EnteredTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExpectedPaymentDate	string	Optional	Shown on sales invoices (Accounts Receivable) when this has been set
FullyPaidOnDate	string	Optional	The date the invoice was fully paid. Only returned on fully paid invoices Read only: true
HasAttachments	boolean	Optional	boolean to indicate if an invoice has an attachment Default: false Read only: true
HasErrors	boolean	Optional	A boolean to indicate if a invoice has an validation errors Default: false
InvoiceAddresses	array	Optional	An array of addresses used to auto calculate sales tax
InvoiceAddresses[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item
InvoiceID	string	Optional	Xero generated unique identifier for invoice Format: uuid
InvoiceNumber	string	Optional	ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) Maximum length: 255
IsDiscounted	boolean	Optional	boolean to indicate if an invoice has a discount Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
Overpayments	array	Optional	See Overpayments Read only: true
Overpayments[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Overpayment
Payments	array	Optional	See Payments Read only: true
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
PlannedPaymentDate	string	Optional	Shown on bills (Accounts Payable) when this has been set
Prepayments	array	Optional	See Prepayments Read only: true
Prepayments[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Prepayment
Reference	string	Optional	ACCREC only – additional reference number
RepeatingInvoiceID	string	Optional	Xero generated unique identifier for repeating invoices Format: uuid
RoundingAmount	JSON	Optional
RoundingAmount (anyOf 1)	number	Alternative	An optional rounding adjustment added to SubTotal + TotalTax to give Total (i.e. Total = SubTotal + TotalTax + RoundingAmount). Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Not validated while the invoice is DRAFT. For SUBMITTED and AUTHORISED invoices, RoundingAmount is only applied when SubTotal, TotalTax and Total are all supplied together, and must be between -0.10 and 0.10 – values outside this range are rejected with a validation error (on DRAFT invoices, an out-of-range value is ignored instead). This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET) Format: double
RoundingAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SentToContact	boolean	Optional	Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved
Status	string	Optional	See Invoice Status Codes Known values: DRAFT, SUBMITTED, DELETED, AUTHORISED, PAID, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of invoice excluding taxes. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can SubTotal be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with TotalTax and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Invoice tax inclusive (i.e. SubTotal + TotalTax + RoundingAmount). Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can Total be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and TotalTax, it is validated against the calculated line item totals plus RoundingAmount; in all other cases this will be ignored if it does not equal the sum of the LineAmounts. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalDiscount	JSON	Optional
TotalDiscount (anyOf 1)	number	Alternative	Total of discounts applied on the invoice line items Format: double Read only: true
TotalDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on invoice. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can TotalTax be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Invoice Types Known values: ACCPAY, ACCPAYCREDIT, APOVERPAYMENT, APPREPAYMENT, ACCREC, ACCRECCREDIT, AROVERPAYMENT, ARPREPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the invoice Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the invoice Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to [appName]” in the Xero app
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Credit Note, Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Deletes an Allocation from a Prepayment — response body — Overpayment, Retrieves payments for invoices and credit notes — response body — Payments item, Deletes an Allocation from a Prepayment — response body — Prepayment, Retrieves journals — response body — Warnings item

Deletes an Allocation from a Prepayment — response body — Invoice Currency Code

Field	Type	Presence	Description and constraints
$	string	Root	3 letter alpha code for the currency – see list of currency codes Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZMK, ZWD

Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	First line of a physical address
AddressLine2	string	Optional	Second line of a physical address
AddressLine3	string	Optional	Third line of a physical address
AddressLine4	string	Optional	Fourth line of a physical address
City	string	Optional	City of a physical address
Country	string	Optional	Country of a physical address
InvoiceAddressType	string	Optional	Indicates whether the address is defined as origin (FROM) or destination (TO) Known values: FROM, TO
PostalCode	string	Optional	Postal code of a physical address
Region	string	Optional	Region or state of a physical address

Deletes an Allocation from a Prepayment — response body — Invoice Line Items item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	The associated account ID related to this line item Format: uuid
Description	string	Optional	Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character
DiscountAmount	JSON	Optional
DiscountAmount (anyOf 1)	number	Alternative	Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. Format: double
DiscountAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
DiscountRate	JSON	Optional
DiscountRate (anyOf 1)	number	Alternative	Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts Format: double
DiscountRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Item	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item
ItemCode	string	Optional	See Items
LineAmount	JSON	Optional
LineAmount (anyOf 1)	number	Alternative	If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount Format: double
LineAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
LineItemID	string	Optional	LineItem unique ID Format: uuid
Quantity	JSON	Optional
Quantity (anyOf 1)	number	Alternative	LineItem Quantity Format: double
Quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
RepeatingInvoiceID	string	Optional	The Xero identifier for a Repeating Invoice Format: uuid
SalesTaxCodeId	JSON	Optional
SalesTaxCodeId (anyOf 1)	number	Alternative	The ID of the sales tax code
SalesTaxCodeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. Format: double
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxBreakdown	array	Optional	An array of tax components defined for this line item
TaxBreakdown[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tax Breakdown item
TaxType	string	Optional	The tax type from TaxRates
Taxability	string	Optional	The type of taxability Known values: TAXABLE, NON_TAXABLE, EXEMPT, PART_TAXABLE, NOT_APPLICABLE
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item
UnitAmount	JSON	Optional
UnitAmount (anyOf 1)	number	Alternative	LineItem Unit Amount Format: double
UnitAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tax Breakdown item

Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item

Field	Type	Presence	Description and constraints
$	JSON	Root
Code	string	Optional	User defined item code (max length = 30) Maximum length: 30
ItemID	string	Optional	The Xero identifier for an Item Format: uuid
Name	string	Optional	The name of the item (max length = 50) Maximum length: 50

Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tax Breakdown item

Field	Type	Presence	Description and constraints
$	object	Root
ExemptAmount	JSON	Optional
ExemptAmount (anyOf 1)	number	Alternative	The amount that is exempt
ExemptAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
JurisdictionRegion	string	Optional	Name identifying the region within the country
Name	string	Optional	The name of the jurisdiction
NonTaxableAmount	JSON	Optional
NonTaxableAmount (anyOf 1)	number	Alternative	The amount that is not taxable
NonTaxableAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
StateAssignedNo	string	Optional	The state assigned number of the jurisdiction
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	The amount of the tax
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxComponentId	string	Optional	The unique ID number of this component Format: uuid
TaxPercentage	JSON	Optional
TaxPercentage (anyOf 1)	number	Alternative	The percentage of the tax
TaxPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxableAmount	JSON	Optional
TaxableAmount (anyOf 1)	number	Alternative	The amount that is taxable
TaxableAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	The type of the jurisdiction Known values: SYSGST/USCOUNTRY, SYSGST/USSTATE, SYSGST/USCOUNTY, SYSGST/USCITY, SYSGST/USSPECIAL

Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking category Maximum length: 100
Option	string	Optional	See Tracking Options
TrackingCategoryID	string	Optional	The Xero identifier for a tracking category Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking category option Format: uuid

Deletes an Allocation from a Prepayment — response body — Overpayment

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body
AppliedAmount	JSON	Optional
AppliedAmount (anyOf 1)	number	Alternative	The amount of applied to an invoice Format: double
AppliedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Attachments	array	Optional	See Attachments
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	The date the overpayment is created YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a overpayment has an attachment Default: false Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Overpayment Line Items
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
OverpaymentID	string	Optional	Xero generated unique identifier Format: uuid
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
Reference	string	Optional	An optional description for Overpayment
RemainingCredit	JSON	Optional
RemainingCredit (anyOf 1)	number	Alternative	The remaining credit balance on the overpayment Format: double
RemainingCredit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Status	string	Optional	See Overpayment Status Codes Known values: AUTHORISED, PAID, VOIDED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	The subtotal of the overpayment excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	The total of the overpayment (subtotal + total tax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	The total tax on the overpayment Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Overpayment Types Known values: RECEIVE-OVERPAYMENT, SPEND-OVERPAYMENT, AROVERPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the overpayment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the overpayment Read only: true

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Deletes an Allocation from a Prepayment — response body, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves payments for invoices and credit notes — response body — Payments item

Deletes an Allocation from a Prepayment — response body — Prepayment

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body
AppliedAmount	JSON	Optional
AppliedAmount (anyOf 1)	number	Alternative	The amount of applied to an invoice Format: double
AppliedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Attachments	array	Optional	See Attachments
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
BrandingThemeID	string	Optional	The unique identifier of the branding template applied to a receive prepayment Format: uuid Read only: true
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	The date the prepayment is created YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a prepayment has an attachment Default: false Read only: true
InvoiceNumber	string	Optional	Returns Invoice number for prepayment receive document only. Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Prepayment Line Items
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
PrepaymentID	string	Optional	Xero generated unique identifier Format: uuid
Reference	string	Optional	Returns Invoice number field. Reference field isn't available. Read only: true
RemainingCredit	JSON	Optional
RemainingCredit (anyOf 1)	number	Alternative	The remaining credit balance on the prepayment Format: double
RemainingCredit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Status	string	Optional	See Prepayment Status Codes Known values: AUTHORISED, PAID, VOIDED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	The subtotal of the prepayment excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	The total of the prepayment(subtotal + total tax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	The total tax on the prepayment Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Prepayment Types Known values: RECEIVE-PREPAYMENT, SPEND-PREPAYMENT, ARPREPAYMENT, APPREPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the prepayment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the prepayment Read only: true

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Deletes an Allocation from a Prepayment — response body, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves payments for invoices and credit notes — response body — Payments item

Deletes one or more bank transfers — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
BankTransfers	array	Optional
BankTransfers[]	Model	Each item	Expand Deletes one or more bank transfers — request body — body Bank Transfers item

Referenced models: Deletes one or more bank transfers — request body — body Bank Transfers item

Deletes one or more bank transfers — request body — body Bank Transfers item

Field	Type	Presence	Description and constraints
$	object	Root
BankTransferID	string	Required within parent	The Xero identifier for a bank transfer Format: uuid
Status	string	Required within parent	The status of the bank transfer. Default: DELETED

Retrieve a list of budgets — response body

Field	Type	Presence	Description and constraints
$	object	Root
Budgets	array	Optional
Budgets[]	Model	Each item	Expand Retrieve a list of budgets — response body — Budgets item

Referenced models: Retrieve a list of budgets — response body — Budgets item

Retrieve a list of budgets — response body — Budgets item

Field	Type	Presence	Description and constraints
$	object	Root
BudgetID	string	Optional	Xero identifier Format: uuid
BudgetLines	array	Optional
BudgetLines[]	Model	Each item	Expand Retrieve a list of budgets — response body — Budgets item Budget Lines item
Description	string	Optional	The Budget description Maximum length: 255
Tracking	array	Optional
Tracking[]	Model	Each item	Expand Create tracking categories — response body — Tracking Categories item
Type	string	Optional	Type of Budget. OVERALL or TRACKING Known values: OVERALL, TRACKING
UpdatedDateUTC	string	Optional	UTC timestamp of last update to budget Read only: true

Referenced models: Retrieve a list of budgets — response body — Budgets item Budget Lines item, Create tracking categories — response body — Tracking Categories item

Retrieve a list of budgets — response body — Budgets item Budget Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	See Accounts Format: uuid
BudgetBalances	array	Optional
BudgetBalances[]	Model	Each item	Expand Retrieve a list of budgets — response body — Budgets item Budget Lines item Budget Balances item

Referenced models: Retrieve a list of budgets — response body — Budgets item Budget Lines item Budget Balances item

Retrieve a list of budgets — response body — Budgets item Budget Lines item Budget Balances item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	LineItem Quantity Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Notes	string	Optional	Any footnotes associated with this balance Maximum length: 255
Period	string	Optional	Period the amount applies to (e.g. “2019-08”)
UnitAmount	JSON	Optional
UnitAmount (anyOf 1)	number	Alternative	Budgeted amount Format: double
UnitAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve reports for 1099 — response body

Field	Type	Presence	Description and constraints
$	object	Root
Reports	array	Optional
Reports[]	Model	Each item	Expand Retrieve reports for 1099 — response body — Reports item

Referenced models: Retrieve reports for 1099 — response body — Reports item

Retrieve reports for 1099 — response body — Reports item

Field	Type	Presence	Description and constraints
$	JSON	Root
Contacts	array	Optional
Contacts[]	Model	Each item	Expand Retrieve reports for 1099 — response body — Reports item Contacts item
ReportDate	string	Optional	Date of report
ReportName	string	Optional	See Prepayment Types
ReportTitle	string	Optional	See Prepayment Types
ReportType	string	Optional	See Prepayment Types Known values: AgedPayablesByContact
UpdatedDateUTC	string	Optional	Updated Date Read only: true

Referenced models: Retrieve reports for 1099 — response body — Reports item Contacts item

Retrieve reports for 1099 — response body — Reports item Contacts item

Field	Type	Presence	Description and constraints
$	JSON	Root
Box1	JSON	Optional
Box1 (anyOf 1)	number	Alternative	Box 1 on 1099 Form Format: double
Box1 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box10	JSON	Optional
Box10 (anyOf 1)	number	Alternative	Box 10 on 1099 Form Format: double
Box10 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box11	JSON	Optional
Box11 (anyOf 1)	number	Alternative	Box 11 on 1099 Form Format: double
Box11 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box13	JSON	Optional
Box13 (anyOf 1)	number	Alternative	Box 13 on 1099 Form Format: double
Box13 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box14	JSON	Optional
Box14 (anyOf 1)	number	Alternative	Box 14 on 1099 Form Format: double
Box14 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box2	JSON	Optional
Box2 (anyOf 1)	number	Alternative	Box 2 on 1099 Form Format: double
Box2 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box3	JSON	Optional
Box3 (anyOf 1)	number	Alternative	Box 3 on 1099 Form Format: double
Box3 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box4	JSON	Optional
Box4 (anyOf 1)	number	Alternative	Box 4 on 1099 Form Format: double
Box4 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box5	JSON	Optional
Box5 (anyOf 1)	number	Alternative	Box 5 on 1099 Form Format: double
Box5 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box6	JSON	Optional
Box6 (anyOf 1)	number	Alternative	Box 6 on 1099 Form Format: double
Box6 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box7	JSON	Optional
Box7 (anyOf 1)	number	Alternative	Box 7 on 1099 Form Format: double
Box7 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box8	JSON	Optional
Box8 (anyOf 1)	number	Alternative	Box 8 on 1099 Form Format: double
Box8 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box9	JSON	Optional
Box9 (anyOf 1)	number	Alternative	Box 9 on 1099 Form Format: double
Box9 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BusinessName	string	Optional	Contact business name
City	string	Optional	Contact city on 1099 Form
ContactId	string	Optional	Contact contact id Format: uuid
Email	string	Optional	Contact email on 1099 Form
FederalTaxClassification	string	Optional	Contact federal tax classification Known values: SOLE_PROPRIETOR, PARTNERSHIP, TRUST_OR_ESTATE, NONPROFIT, C_CORP, S_CORP, OTHER
FederalTaxIDType	string	Optional	Contact Fed Tax ID type
LegalName	string	Optional	Contact legal name
Name	string	Optional	Contact name on 1099 Form
State	string	Optional	Contact State on 1099 Form
StreetAddress	string	Optional	Contact address on 1099 Form
TaxID	string	Optional	Contact tax id on 1099 Form
Zip	string	Optional	Contact zip on 1099 Form

Retrieves CIS settings for a specific contact in a Xero organisation — response body

Field	Type	Presence	Description and constraints
$	object	Root
CISSettings	array	Optional
CISSettings[]	Model	Each item	Expand Retrieves CIS settings for a specific contact in a Xero organisation — response body — CIS Settings item

Referenced models: Retrieves CIS settings for a specific contact in a Xero organisation — response body — CIS Settings item

Retrieves CIS settings for a specific contact in a Xero organisation — response body — CIS Settings item

Field	Type	Presence	Description and constraints
$	JSON	Root
CISEnabled	boolean	Optional	Boolean that describes if the contact is a CIS Subcontractor
Rate	JSON	Optional
Rate (anyOf 1)	number	Alternative	CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned Format: double Read only: true
Rate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves Xero organisation details — response body

Field	Type	Presence	Description and constraints
$	object	Root
Organisations	array	Optional
Organisations[]	Model	Each item	Expand Retrieves Xero organisation details — response body — Organisations item

Referenced models: Retrieves Xero organisation details — response body — Organisations item

Retrieves Xero organisation details — response body — Organisations item

Field	Type	Presence	Description and constraints
$	object	Root
APIKey	string	Optional	Display a unique key used for Xero-to-Xero transactions
Addresses	array	Optional	Address details for organisation – see Addresses
Addresses[]	Model	Each item	Expand Retrieves Xero organisation details — response body — Organisations item Addresses item
BaseCurrency	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
Class	string	Optional	Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) Known values: DEMO, TRIAL, STARTER, STANDARD, PREMIUM, PREMIUM_20, PREMIUM_50, PREMIUM_100, LEDGER, GST_CASHBOOK, NON_GST_CASHBOOK, ULTIMATE, LITE, ULTIMATE_10, ULTIMATE_20, ULTIMATE_50, ULTIMATE_100, IGNITE, GROW, COMPREHENSIVE, SIMPLE, BASICLITE, ULTRA
CountryCode	Model	Optional	Expand Retrieves Xero organisation details — response body — Organisations item Country Code
CreatedDateUTC	string	Optional	Timestamp when the organisation was created in Xero Read only: true
DefaultPurchasesTax	string	Optional	The default for LineAmountTypes on purchase transactions
DefaultSalesTax	string	Optional	The default for LineAmountTypes on sales transactions
Edition	string	Optional	BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing) Known values: BUSINESS, PARTNER
EmployerIdentificationNumber	string	Optional	Shown if set. US Only.
EndOfYearLockDate	string	Optional	Shown if set. See lock dates
ExternalLinks	array	Optional	Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below
ExternalLinks[]	Model	Each item	Expand Retrieves Xero organisation details — response body — Organisations item External Links item
FinancialYearEndDay	JSON	Optional
FinancialYearEndDay (anyOf 1)	integer	Alternative	Calendar day e.g. 0-31
FinancialYearEndDay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
FinancialYearEndMonth	JSON	Optional
FinancialYearEndMonth (anyOf 1)	integer	Alternative	Calendar Month e.g. 1-12
FinancialYearEndMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
IsDemoCompany	boolean	Optional	Boolean to describe if organisation is a demo company.
LegalName	string	Optional	Organisation name shown on Reports
LineOfBusiness	string	Optional	Description of business type as defined in Organisation settings
Name	string	Optional	Display name of organisation shown in Xero
OrganisationEntityType	string	Optional	Organisation Entity Type Known values: ACCOUNTING_PRACTICE, COMPANY, CHARITY, CLUB_OR_SOCIETY, INDIVIDUAL, LOOK_THROUGH_COMPANY, NOT_FOR_PROFIT, PARTNERSHIP, S_CORPORATION, SELF_MANAGED_SUPERANNUATION_FUND, SOLE_TRADER, SUPERANNUATION_FUND, TRUST, PERSONAL, SINGLEMEMBERLLC, CCORPORATIONLLC, PARTNERSHIPLLC, SCORPORATIONLLC, LLC, NOTLLC, UNSPECIFIED
OrganisationID	string	Optional	Unique Xero identifier Format: uuid
OrganisationStatus	string	Optional	Will be set to ACTIVE if you can connect to organisation via the Xero API
OrganisationType	string	Optional	Organisation Type Known values: ACCOUNTING_PRACTICE, COMPANY, CHARITY, CLUB_OR_SOCIETY, INDIVIDUAL, LOOK_THROUGH_COMPANY, NOT_FOR_PROFIT, PARTNERSHIP, S_CORPORATION, SELF_MANAGED_SUPERANNUATION_FUND, SOLE_TRADER, SUPERANNUATION_FUND, TRUST, PERSONAL, SINGLEMEMBERLLC, CCORPORATIONLLC, PARTNERSHIPLLC, SCORPORATIONLLC, LLC, NOTLLC, UNSPECIFIED
PaymentTerms	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Payment Terms
PaysTax	boolean	Optional	Boolean to describe if organisation is registered with a local tax authority i.e. true, false
PeriodLockDate	string	Optional	Shown if set. See lock dates
Phones	array	Optional	Phones details for organisation – see Phones
Phones[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Phones item
RegistrationNumber	string	Optional	Shows for New Zealand, Australian and UK organisations
SalesTaxBasis	string	Optional	The accounting basis used for tax returns. See Sales Tax Basis Known values: PAYMENTS, INVOICE, NONE, CASH, ACCRUAL, FLATRATECASH, FLATRATEACCRUAL, ACCRUALS
SalesTaxPeriod	string	Optional	The frequency with which tax returns are processed. See Sales Tax Period Known values: MONTHLY, QUARTERLY1, QUARTERLY2, QUARTERLY3, ANNUALLY, ONEMONTHS, TWOMONTHS, SIXMONTHS, 1MONTHLY, 2MONTHLY, 3MONTHLY, 6MONTHLY, QUARTERLY, YEARLY, NONE
ShortCode	string	Optional	A unique identifier for the organisation. Potential uses.
TaxNumber	string	Optional	Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global).
Timezone	Model	Optional	Expand Retrieves Xero organisation details — response body — Organisations item Timezone
Version	string	Optional	See Version Types Known values: AU, NZ, GLOBAL, UK, US, AUONRAMP, NZONRAMP, GLOBALONRAMP, UKONRAMP, USONRAMP

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Retrieves Xero organisation details — response body — Organisations item Addresses item, Retrieves Xero organisation details — response body — Organisations item Country Code, Retrieves Xero organisation details — response body — Organisations item External Links item, Creates contacts to a specific contact group — response body — Contacts item Payment Terms, Creates contacts to a specific contact group — response body — Contacts item Phones item, Retrieves Xero organisation details — response body — Organisations item Timezone

Retrieves Xero organisation details — response body — Organisations item Addresses item

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	max length = 500 Maximum length: 500
AddressLine2	string	Optional	max length = 500 Maximum length: 500
AddressLine3	string	Optional	max length = 500 Maximum length: 500
AddressLine4	string	Optional	max length = 500 Maximum length: 500
AddressType	string	Optional	define the type of address Known values: POBOX, STREET, DELIVERY
AttentionTo	string	Optional	max length = 255 Maximum length: 255
City	string	Optional	max length = 255 Maximum length: 255
Country	string	Optional	max length = 50, [A-Z], [a-z] only Maximum length: 50
PostalCode	string	Optional	max length = 50 Maximum length: 50
Region	string	Optional	max length = 255 Maximum length: 255

Retrieves Xero organisation details — response body — Organisations item Country Code

Field	Type	Presence	Description and constraints
$	string	Root	Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GG, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Retrieves Xero organisation details — response body — Organisations item External Links item

Field	Type	Presence	Description and constraints
$	object	Root
Description	string	Optional
LinkType	string	Optional	See External link types Known values: Facebook, GooglePlus, LinkedIn, Twitter, Website
Url	string	Optional	URL for service e.g. http://twitter.com/xeroapi

Retrieves Xero organisation details — response body — Organisations item Timezone

Field	Type	Presence	Description and constraints
$	string	Root	Timezone specifications Known values: AFGHANISTANSTANDARDTIME, ALASKANSTANDARDTIME, ALEUTIANSTANDARDTIME, ALTAISTANDARDTIME, ARABIANSTANDARDTIME, ARABICSTANDARDTIME, ARABSTANDARDTIME, ARGENTINASTANDARDTIME, ASTRAKHANSTANDARDTIME, ATLANTICSTANDARDTIME, AUSCENTRALSTANDARDTIME, AUSCENTRALWSTANDARDTIME, AUSEASTERNSTANDARDTIME, AZERBAIJANSTANDARDTIME, AZORESSTANDARDTIME, BAHIASTANDARDTIME, BANGLADESHSTANDARDTIME, BELARUSSTANDARDTIME, BOUGAINVILLESTANDARDTIME, CANADACENTRALSTANDARDTIME, CAPEVERDESTANDARDTIME, CAUCASUSSTANDARDTIME, CENAUSTRALIASTANDARDTIME, CENTRALAMERICASTANDARDTIME, CENTRALASIASTANDARDTIME, CENTRALBRAZILIANSTANDARDTIME, CENTRALEUROPEANSTANDARDTIME, CENTRALEUROPESTANDARDTIME, CENTRALPACIFICSTANDARDTIME, CENTRALSTANDARDTIME, CENTRALSTANDARDTIME(MEXICO), CHATHAMISLANDSSTANDARDTIME, CHINASTANDARDTIME, CUBASTANDARDTIME, DATELINESTANDARDTIME, EAFRICASTANDARDTIME, EASTERISLANDSTANDARDTIME, EASTERNSTANDARDTIME, EASTERNSTANDARDTIME(MEXICO), EAUSTRALIASTANDARDTIME, EEUROPESTANDARDTIME, EGYPTSTANDARDTIME, EKATERINBURGSTANDARDTIME, ESOUTHAMERICASTANDARDTIME, FIJISTANDARDTIME, FLESTANDARDTIME, GEORGIANSTANDARDTIME, GMTSTANDARDTIME, GREENLANDSTANDARDTIME, GREENWICHSTANDARDTIME, GTBSTANDARDTIME, HAITISTANDARDTIME, HAWAIIANSTANDARDTIME, INDIASTANDARDTIME, IRANSTANDARDTIME, ISRAELSTANDARDTIME, JORDANSTANDARDTIME, KALININGRADSTANDARDTIME, KAMCHATKASTANDARDTIME, KOREASTANDARDTIME, LIBYASTANDARDTIME, LINEISLANDSSTANDARDTIME, LORDHOWESTANDARDTIME, MAGADANSTANDARDTIME, MAGALLANESSTANDARDTIME, MARQUESASSTANDARDTIME, MAURITIUSSTANDARDTIME, MIDATLANTICSTANDARDTIME, MIDDLEEASTSTANDARDTIME, MONTEVIDEOSTANDARDTIME, MOROCCOSTANDARDTIME, MOUNTAINSTANDARDTIME, MOUNTAINSTANDARDTIME(MEXICO), MYANMARSTANDARDTIME, NAMIBIASTANDARDTIME, NCENTRALASIASTANDARDTIME, NEPALSTANDARDTIME, NEWFOUNDLANDSTANDARDTIME, NEWZEALANDSTANDARDTIME, NORFOLKSTANDARDTIME, NORTHASIAEASTSTANDARDTIME, NORTHASIASTANDARDTIME, NORTHKOREASTANDARDTIME, OMSKSTANDARDTIME, PACIFICSASTANDARDTIME, PACIFICSTANDARDTIME, PACIFICSTANDARDTIME(MEXICO), PAKISTANSTANDARDTIME, PARAGUAYSTANDARDTIME, QYZYLORDASTANDARDTIME, ROMANCESTANDARDTIME, RUSSIANSTANDARDTIME, RUSSIATIMEZONE10, RUSSIATIMEZONE11, RUSSIATIMEZONE3, SAEASTERNSTANDARDTIME, SAINTPIERRESTANDARDTIME, SAKHALINSTANDARDTIME, SAMOASTANDARDTIME, SAOTOMESTANDARDTIME, SAPACIFICSTANDARDTIME, SARATOVSTANDARDTIME, SAWESTERNSTANDARDTIME, SEASIASTANDARDTIME, SINGAPORESTANDARDTIME, SOUTHAFRICASTANDARDTIME, SOUTHSUDANSTANDARDTIME, SRILANKASTANDARDTIME, SUDANSTANDARDTIME, SYRIASTANDARDTIME, TAIPEISTANDARDTIME, TASMANIASTANDARDTIME, TOCANTINSSTANDARDTIME, TOKYOSTANDARDTIME, TOMSKSTANDARDTIME, TONGASTANDARDTIME, TRANSBAIKALSTANDARDTIME, TURKEYSTANDARDTIME, TURKSANDCAICOSSTANDARDTIME, ULAANBAATARSTANDARDTIME, USEASTERNSTANDARDTIME, USMOUNTAINSTANDARDTIME, UTC, UTC+12, UTC+13, UTC02, UTC08, UTC09, UTC11, VENEZUELASTANDARDTIME, VLADIVOSTOKSTANDARDTIME, VOLGOGRADSTANDARDTIME, WAUSTRALIASTANDARDTIME, WCENTRALAFRICASTANDARDTIME, WESTASIASTANDARDTIME, WESTBANKSTANDARDTIME, WESTPACIFICSTANDARDTIME, WEUROPESTANDARDTIME, WMONGOLIASTANDARDTIME, YAKUTSKSTANDARDTIME, YUKONSTANDARDTIME

Retrieves a URL to an online invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
OnlineInvoices	array	Optional
OnlineInvoices[]	Model	Each item	Expand Retrieves a URL to an online invoice — response body — Online Invoices item

Referenced models: Retrieves a URL to an online invoice — response body — Online Invoices item

Retrieves a URL to an online invoice — response body — Online Invoices item

Field	Type	Presence	Description and constraints
$	object	Root
OnlineInvoiceUrl	string	Optional	the URL to an online invoice

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation — response body

Field	Type	Presence	Description and constraints
$	object	Root
Actions	array	Optional
Actions[]	Model	Each item	Expand Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation — response body — Actions item

Referenced models: Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation — response body — Actions item

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation — response body — Actions item

Field	Type	Presence	Description and constraints
$	JSON	Root
Name	string	Optional	Name of the actions for this organisation
Status	string	Optional	Status of the action for this organisation Known values: ALLOWED, NOT-ALLOWED

Retrieves all the branding themes — response body

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemes	array	Optional
BrandingThemes[]	Model	Each item	Expand Retrieves all the branding themes — response body — Branding Themes item

Referenced models: Retrieves all the branding themes — response body — Branding Themes item

Retrieves all the branding themes — response body — Branding Themes item

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	Xero identifier Format: uuid
CreatedDateUTC	string	Optional	UTC timestamp of creation date of branding theme Read only: true
LogoUrl	string	Optional	The location of the image file used as the logo on this branding theme
Name	string	Optional	Name of branding theme
SortOrder	JSON	Optional
SortOrder (anyOf 1)	integer	Alternative	Integer – ranked order of branding theme. The default branding theme has a value of 0
SortOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	Always INVOICE Known values: INVOICE

Retrieves any spent or received money transactions — response body

Field	Type	Presence	Description and constraints
$	object	Root
BankTransactions	array	Optional
BankTransactions[]	Model	Each item	Expand Retrieves any spent or received money transactions — response body — Bank Transactions item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves any spent or received money transactions — response body — Bank Transactions item, Retrieves journals — response body — Warnings item

Retrieves any spent or received money transactions — response body — Bank Transactions item

Field	Type	Presence	Description and constraints
$	object	Root
BankAccount	Model	Required within parent	Expand Deletes a chart of accounts — response body — Accounts item
BankTransactionID	string	Optional	Xero generated unique identifier for bank transaction Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date of transaction – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a bank transaction has an attachment Default: false Read only: true
IsReconciled	boolean	Optional	Boolean to show if transaction is reconciled
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Required within parent	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
OverpaymentID	string	Optional	Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT Format: uuid Read only: true
PrepaymentID	string	Optional	Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT Format: uuid Read only: true
Reference	string	Optional	Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
Status	string	Optional	See Bank Transaction Status Codes Known values: AUTHORISED, DELETED, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of bank transaction excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of bank transaction tax inclusive Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on bank transaction Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Required within parent	See Bank Transaction Types Known values: RECEIVE, RECEIVE-OVERPAYMENT, RECEIVE-PREPAYMENT, SPEND, SPEND-OVERPAYMENT, SPEND-PREPAYMENT, RECEIVE-TRANSFER, SPEND-TRANSFER
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to App Name”
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes a chart of accounts — response body — Accounts item, Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves journals — response body — Warnings item

Retrieves history for a specific item — response body

Field	Type	Presence	Description and constraints
$	object	Root
HistoryRecords	array	Optional
HistoryRecords[]	Model	Each item	Expand Retrieves history for a specific item — response body — History Records item

Referenced models: Retrieves history for a specific item — response body — History Records item

Retrieves history for a specific item — response body — History Records item

Field	Type	Presence	Description and constraints
$	object	Root
Changes	string	Optional	Name of branding theme
DateUTC	string	Optional	UTC timestamp of creation date of branding theme Read only: true
Details	string	Optional	details
User	string	Optional	has a value of 0

Retrieves invoice reminder settings — response body

Field	Type	Presence	Description and constraints
$	object	Root
InvoiceReminders	array	Optional
InvoiceReminders[]	Model	Each item	Expand Retrieves invoice reminder settings — response body — Invoice Reminders item

Referenced models: Retrieves invoice reminder settings — response body — Invoice Reminders item

Retrieves invoice reminder settings — response body — Invoice Reminders item

Field	Type	Presence	Description and constraints
$	object	Root
Enabled	boolean	Optional	setting for on or off

Retrieves items — response body

Field	Type	Presence	Description and constraints
$	object	Root
Items	array	Optional
Items[]	Model	Each item	Expand Retrieves items — response body — Items item

Referenced models: Retrieves items — response body — Items item

Retrieves items — response body — Items item

Field	Type	Presence	Description and constraints
$	object	Root
Code	string	Required within parent	User defined item code (max length = 30) Maximum length: 30
Description	string	Optional	The sales description of the item (max length = 4000) Maximum length: 4000
InventoryAssetAccountCode	string	Optional	The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item
IsPurchased	boolean	Optional	Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.
IsSold	boolean	Optional	Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.
IsTrackedAsInventory	boolean	Optional	True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
ItemID	string	Optional	The Xero identifier for an Item Format: uuid
Name	string	Optional	The name of the item (max length = 50) Maximum length: 50
PurchaseDescription	string	Optional	The purchase description of the item (max length = 4000) Maximum length: 4000
PurchaseDetails	Model	Optional	Expand Retrieves items — response body — Items item Sales Details
QuantityAvailable	JSON	Optional
QuantityAvailable (anyOf 1)	number	Alternative	The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. Format: double Read only: true
QuantityAvailable (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
QuantityOnBackOrder	JSON	Optional
QuantityOnBackOrder (anyOf 1)	number	Alternative	The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. Format: double Read only: true
QuantityOnBackOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
QuantityOnHand	JSON	Optional
QuantityOnHand (anyOf 1)	number	Alternative	The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. Format: double
QuantityOnHand (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SalesDetails	Model	Optional	Expand Retrieves items — response body — Items item Sales Details
StatusAttributeString	string	Optional	Status of object
TotalCostPool	JSON	Optional
TotalCostPool (anyOf 1)	number	Alternative	The value of the item on hand. Calculated using average cost accounting. Format: double
TotalCostPool (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date in UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves items — response body — Items item Sales Details, Retrieves journals — response body — Warnings item

Retrieves items — response body — Items item Sales Details

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items
COGSAccountCode	string	Optional	Cost of goods sold account. Only applicable to the purchase details of tracked items.
TaxType	string	Optional	The tax type from TaxRates
UnitPrice	JSON	Optional
UnitPrice (anyOf 1)	number	Alternative	Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request. Format: double
UnitPrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves journals — response body

Field	Type	Presence	Description and constraints
$	object	Root
Journals	array	Optional
Journals[]	Model	Each item	Expand Retrieves journals — response body — Journals item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Journals item, Retrieves journals — response body — Warnings item

Retrieves journals — response body — Journals item

Field	Type	Presence	Description and constraints
$	object	Root
CreatedDateUTC	string	Optional	Created date UTC format Read only: true
JournalDate	string	Optional	Date the journal was posted
JournalID	string	Optional	Xero identifier Format: uuid
JournalLines	array	Optional	See JournalLines
JournalLines[]	Model	Each item	Expand Retrieves journals — response body — Journals item Journal Lines item
JournalNumber	JSON	Optional
JournalNumber (anyOf 1)	integer	Alternative	Xero generated journal number
JournalNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Reference	string	Optional	reference field for additional indetifying information
SourceID	string	Optional	The identifier for the source transaction (e.g. InvoiceID) Format: uuid
SourceType	string	Optional	The journal source type. The type of transaction that created the journal Known values: ACCREC, ACCPAY, ACCRECCREDIT, ACCPAYCREDIT, ACCRECPAYMENT, ACCPAYPAYMENT, ARCREDITPAYMENT, APCREDITPAYMENT, CASHREC, CASHPAID, TRANSFER, ARPREPAYMENT, APPREPAYMENT, AROVERPAYMENT, APOVERPAYMENT, EXPCLAIM, EXPPAYMENT, MANJOURNAL, PAYSLIP, WAGEPAYABLE, INTEGRATEDPAYROLLPE, INTEGRATEDPAYROLLPT, EXTERNALSPENDMONEY, INTEGRATEDPAYROLLPTPAYMENT, INTEGRATEDPAYROLLCN

Referenced models: Retrieves journals — response body — Journals item Journal Lines item

Retrieves journals — response body — Journals item Journal Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	See Accounts Format: uuid
AccountName	string	Optional	See AccountCodes
AccountType	string	Optional	See Account Types Known values: BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, EXPENSE, FIXED, INVENTORY, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYG
Description	string	Optional	The description from the source transaction line item. Only returned if populated.
GrossAmount	JSON	Optional
GrossAmount (anyOf 1)	number	Alternative	Gross amount of journal line (NetAmount + TaxAmount). Format: double
GrossAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
JournalLineID	string	Optional	Xero identifier for Journal Format: uuid
NetAmount	JSON	Optional
NetAmount (anyOf 1)	number	Alternative	Net amount of journal line. This will be a positive value for a debit and negative for a credit Format: double
NetAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	Total tax on a journal line Format: double Read only: true
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxName	string	Optional	see TaxRates
TaxType	string	Optional	The tax type from taxRates
TrackingCategories	array	Optional	Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
TrackingCategories[]	Model	Each item	Expand Create tracking categories — response body — Tracking Categories item

Referenced models: Create tracking categories — response body — Tracking Categories item

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

Retrieves manual journals — response body

Field	Type	Presence	Description and constraints
$	object	Root
ManualJournals	array	Optional
ManualJournals[]	Model	Each item	Expand Retrieves manual journals — response body — Manual Journals item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves manual journals — response body — Manual Journals item, Retrieves journals — response body — Warnings item

Retrieves manual journals — response body — Manual Journals item

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
Date	string	Optional	Date journal was posted – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a manual journal has an attachment Default: false Read only: true
JournalLines	array	Optional	See JournalLines
JournalLines[]	Model	Each item	Expand Retrieves manual journals — response body — Manual Journals item Journal Lines item
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
ManualJournalID	string	Optional	The Xero identifier for a Manual Journal Format: uuid
Narration	string	Required within parent	Description of journal being posted
ShowOnCashBasisReports	boolean	Optional	Boolean – default is true if not specified
Status	string	Optional	See Manual Journal Status Codes Known values: DRAFT, POSTED, DELETED, VOIDED, ARCHIVED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	Url link to a source document – shown as “Go to [appName]” in the Xero app
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: create Contact Attachment By File Name — response body — Attachments item, Retrieves manual journals — response body — Manual Journals item Journal Lines item, Retrieves journals — response body — Warnings item

Retrieves manual journals — response body — Manual Journals item Journal Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	See Accounts Format: uuid
Description	string	Optional	Description for journal line
IsBlank	boolean	Optional	is the line blank
LineAmount	JSON	Optional
LineAmount (anyOf 1)	number	Alternative	total for line. Debits are positive, credits are negative value Format: double
LineAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	The calculated tax amount based on the TaxType and LineAmount Format: double
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxType	string	Optional	The tax type from TaxRates
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Create tracking categories — response body — Tracking Categories item

Referenced models: Create tracking categories — response body — Tracking Categories item

Retrieves overpayments — response body

Field	Type	Presence	Description and constraints
$	object	Root
Overpayments	array	Optional
Overpayments[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Overpayment
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Deletes an Allocation from a Prepayment — response body — Overpayment, Retrieves journals — response body — Warnings item

Retrieves payments for invoices and credit notes — response body

Field	Type	Presence	Description and constraints
$	object	Root
Payments	array	Optional
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves payments for invoices and credit notes — response body — Payments item, Retrieves journals — response body — Warnings item

Retrieves payments for invoices and credit notes — response body — Payments item

Field	Type	Presence	Description and constraints
$	object	Root
Account	Model	Optional	Expand Deletes a chart of accounts — response body — Accounts item
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BankAccountNumber	string	Optional	The suppliers bank account number the payment is being made to
BankAmount	JSON	Optional
BankAmount (anyOf 1)	number	Alternative	The amount of the payment in the currency of the bank account. Format: double
BankAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BatchPayment	Model	Optional	Expand Creates one or many batch payments for invoices — response body — Batch Payments item
BatchPaymentID	string	Optional	Present if the payment was created as part of a batch. Format: uuid
Code	string	Optional	Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)
CreditNote	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Credit Note
CreditNoteNumber	string	Optional	Number of invoice or credit note you are applying payment to e.g. INV-4003
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Details	string	Optional	The information to appear on the supplier's bank account
HasAccount	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
HasValidationErrors	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
Invoice	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice
InvoiceNumber	string	Optional	Number of invoice or credit note you are applying payment to e.g.INV-4003
IsReconciled	boolean	Optional	An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET
Overpayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Overpayment
Particulars	string	Optional	The suppliers bank account number the payment is being made to
PaymentID	string	Optional	The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
PaymentType	string	Optional	See Payment Types. Known values: ACCRECPAYMENT, ACCPAYPAYMENT, ARCREDITPAYMENT, APCREDITPAYMENT, AROVERPAYMENTPAYMENT, ARPREPAYMENTPAYMENT, APPREPAYMENTPAYMENT, APOVERPAYMENTPAYMENT Read only: true
Prepayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Prepayment
Reference	string	Optional	An optional description for the payment e.g. Direct Debit
Status	string	Optional	The status of the payment. Known values: AUTHORISED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the payment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the payment Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes a chart of accounts — response body — Accounts item, Creates one or many batch payments for invoices — response body — Batch Payments item, Deletes an Allocation from a Prepayment — response body — Credit Note, Deletes an Allocation from a Prepayment — response body — Invoice, Deletes an Allocation from a Prepayment — response body — Overpayment, Deletes an Allocation from a Prepayment — response body — Prepayment, Retrieves journals — response body — Warnings item

Retrieves prepayments — response body

Field	Type	Presence	Description and constraints
$	object	Root
Prepayments	array	Optional
Prepayments[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Prepayment
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Deletes an Allocation from a Prepayment — response body — Prepayment, Retrieves journals — response body — Warnings item

Retrieves prepayments — response body — pagination

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	JSON	Optional
itemCount (anyOf 1)	integer	Alternative
itemCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page	JSON	Optional
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageCount	JSON	Optional
pageCount (anyOf 1)	integer	Alternative
pageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	integer	Alternative
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves purchase orders — response body

Field	Type	Presence	Description and constraints
$	object	Root
PurchaseOrders	array	Optional
PurchaseOrders[]	Model	Each item	Expand Retrieves purchase orders — response body — Purchase Orders item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves purchase orders — response body — Purchase Orders item, Retrieves journals — response body — Warnings item

Retrieves purchase orders — response body — Purchase Orders item

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
AttentionTo	string	Optional	The person that the delivery is going to
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used. Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date 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
DeliveryAddress	string	Optional	The address the goods are to be delivered to
DeliveryDate	string	Optional	Date the goods are to be delivered – YYYY-MM-DD
DeliveryInstructions	string	Optional	A free text feild for instructions (500 characters max)
ExpectedArrivalDate	string	Optional	The date the goods are expected to arrive.
HasAttachments	boolean	Optional	boolean to indicate if a purchase order has an attachment Default: false Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
PurchaseOrderID	string	Optional	Xero generated unique identifier for purchase order Format: uuid
PurchaseOrderNumber	string	Optional	Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
Reference	string	Optional	Additional reference number
SentToContact	boolean	Optional	Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed
Status	string	Optional	See Purchase Order Status Codes Known values: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of purchase order excluding taxes Format: double Read only: true
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Telephone	string	Optional	The phone number for the person accepting the delivery
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) Format: double Read only: true
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalDiscount	JSON	Optional
TotalDiscount (anyOf 1)	number	Alternative	Total of discounts applied on the purchase order line items Format: double Read only: true
TotalDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on purchase order Format: double Read only: true
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves journals — response body — Warnings item

Retrieves repeating invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root
RepeatingInvoices	array	Optional
RepeatingInvoices[]	Model	Each item	Expand Retrieves repeating invoices — response body — Repeating Invoices item

Referenced models: Retrieves repeating invoices — response body — Repeating Invoices item

Retrieves repeating invoices — response body — Repeating Invoices item

Field	Type	Presence	Description and constraints
$	object	Root
ApprovedForSending	boolean	Optional	Boolean to indicate whether the invoice has been approved for sending Default: false
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
HasAttachments	boolean	Optional	Boolean to indicate if an invoice has an attachment Default: false Read only: true
ID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
IncludePDF	boolean	Optional	Boolean to indicate whether to include PDF attachment Default: false
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
MarkAsSent	boolean	Optional	Boolean to indicate whether the invoice in the Xero app displays as "sent" Default: false
Reference	string	Optional	ACCREC only – additional reference number
RepeatingInvoiceID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
Schedule	Model	Optional	Expand Retrieves repeating invoices — response body — Repeating Invoices item Schedule
SendCopy	boolean	Optional	Boolean to indicate whether a copy is sent to sender's email Default: false
Status	string	Optional	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes Known values: DRAFT, AUTHORISED, DELETED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of invoice excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on invoice Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Invoice Types Known values: ACCPAY, ACCREC

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves repeating invoices — response body — Repeating Invoices item Schedule

Retrieves repeating invoices — response body — Repeating Invoices item Schedule

Field	Type	Presence	Description and constraints
$	object	Root
DueDate	JSON	Optional
DueDate (anyOf 1)	integer	Alternative	Integer used with due date type e.g 20 (of following month), 31 (of current month)
DueDate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
DueDateType	string	Optional	the payment terms Known values: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, DAYSAFTERINVOICEDATE, DAYSAFTERINVOICEMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH
EndDate	string	Optional	Invoice end date – only returned if the template has an end date set
NextScheduledDate	string	Optional	The calendar date of the next invoice in the schedule to be generated
Period	JSON	Optional
Period (anyOf 1)	integer	Alternative	Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
Period (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
StartDate	string	Optional	Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
Unit	string	Optional	One of the following - WEEKLY or MONTHLY Known values: WEEKLY, MONTHLY

Retrieves report for balancesheet — response body

Field	Type	Presence	Description and constraints
$	object	Root
Reports	array	Optional
Reports[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item

Referenced models: Retrieves report for balancesheet — response body — Reports item

Retrieves report for balancesheet — response body — Reports item

Field	Type	Presence	Description and constraints
$	JSON	Root
Fields	array	Optional
Fields[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Fields item
ReportDate	string	Optional	Date of report
ReportID	string	Optional	ID of the Report
ReportName	string	Optional	Name of the report
ReportTitle	string	Optional	Title of the report
ReportTitles	array	Optional	Report titles array (3 to 4 strings with the report name, orgnisation name and time frame of report)
ReportTitles[]	string	Each item
ReportType	string	Optional	The type of report (BalanceSheet,ProfitLoss, etc)
Rows	array	Optional
Rows[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item
UpdatedDateUTC	string	Optional	Updated Date Read only: true

Referenced models: Retrieves report for balancesheet — response body — Reports item Fields item, Retrieves report for balancesheet — response body — Reports item Rows item

Retrieves report for balancesheet — response body — Reports item Fields item

Field	Type	Presence	Description and constraints
$	object	Root
Description	string	Optional
FieldID	string	Optional
Value	string	Optional

Retrieves report for balancesheet — response body — Reports item Rows item

Field	Type	Presence	Description and constraints
$	object	Root
Cells	array	Optional
Cells[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item
RowType	string	Optional	Known values: Header, Section, Row, SummaryRow
Rows	array	Optional
Rows[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Rows item
Title	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item, Retrieves report for balancesheet — response body — Reports item Rows item Rows item

Retrieves report for balancesheet — response body — Reports item Rows item Cells item

Field	Type	Presence	Description and constraints
$	object	Root
Attributes	array	Optional
Attributes[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item
Value	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item

Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item

Field	Type	Presence	Description and constraints
$	JSON	Root
Id	string	Optional
Value	string	Optional

Retrieves report for balancesheet — response body — Reports item Rows item Rows item

Field	Type	Presence	Description and constraints
$	object	Root
Cells	array	Optional
Cells[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item
RowType	string	Optional	Known values: Header, Section, Row, SummaryRow
Title	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item

Retrieves sales invoices or purchase bills — response body

Field	Type	Presence	Description and constraints
$	object	Root
Invoices	array	Optional
Invoices[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Deletes an Allocation from a Prepayment — response body — Invoice, Retrieves journals — response body — Warnings item

Retrieves sales quotes — response body

Field	Type	Presence	Description and constraints
$	object	Root
Quotes	array	Optional
Quotes[]	Model	Each item	Expand Retrieves sales quotes — response body — Quotes item

Referenced models: Retrieves sales quotes — response body — Quotes item

Retrieves sales quotes — response body — Quotes item

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency quote Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date quote 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
DateString	string	Optional	Date the quote was issued (YYYY-MM-DD)
ExpiryDate	string	Optional	Date the quote expires – YYYY-MM-DD.
ExpiryDateString	string	Optional	Date the quote expires – YYYY-MM-DD.
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types See Quote Line Amount Types Known values: EXCLUSIVE, INCLUSIVE, NOTAX
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
QuoteID	string	Optional	QuoteID GUID is automatically generated and is returned after create or GET. Format: uuid
QuoteNumber	string	Optional	Unique alpha numeric code identifying a quote (Max Length = 255) Maximum length: 255
Reference	string	Optional	Additional reference number Maximum length: 4000
Status	string	Optional	The status of the quote. Known values: DRAFT, SENT, DECLINED, ACCEPTED, INVOICED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of quote excluding taxes. Format: double Read only: true
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Summary	string	Optional	Summary text for the quote Maximum length: 3000
Terms	string	Optional	Terms of the quote Maximum length: 4000
Title	string	Optional	Title text for the quote Maximum length: 100
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts Format: double Read only: true
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalDiscount	JSON	Optional
TotalDiscount (anyOf 1)	number	Alternative	Total of discounts applied on the quote line items Format: double Read only: true
TotalDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on quote Format: double Read only: true
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves journals — response body — Warnings item

Retrieves the CIS settings for the Xero organistaion — response body

Field	Type	Presence	Description and constraints
$	object	Root
CISSettings	array	Optional
CISSettings[]	Model	Each item	Expand Retrieves the CIS settings for the Xero organistaion — response body — CIS Settings item

Referenced models: Retrieves the CIS settings for the Xero organistaion — response body — CIS Settings item

Retrieves the CIS settings for the Xero organistaion — response body — CIS Settings item

Field	Type	Presence	Description and constraints
$	JSON	Root
CISContractorEnabled	boolean	Optional	true or false - Boolean that describes if the organisation is a CIS Contractor
CISSubContractorEnabled	boolean	Optional	true or false - Boolean that describes if the organisation is a CIS SubContractor
Rate	JSON	Optional
Rate (anyOf 1)	number	Alternative	CIS Deduction rate for the organisation Format: double Read only: true
Rate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$