--- title: "Updates a specific batch payment for invoices and credit notes" method: POST path: "/BatchPayments/{BatchPaymentID}" tags: ["Accounting"] --- # Updates a specific batch payment for invoices and credit notes `POST /BatchPayments/{BatchPaymentID}` ## Path parameters - `BatchPaymentID` string, uuid, required ## Headers - `Idempotency-Key` string ## Request body - BatchPaymentDeleteByUrlParam - `Status` string, required — The status of the batch payment. ## Response `200` Success - return response of type BatchPayments array for updated BatchPayment - BatchPayments - `BatchPayments` BatchPayment[] - `Account` Account - `Code` string — Customer defined alpha numeric account code e.g 200 or SALES (max length = 10) - `Name` string — Name of account (max length = 150) - `AccountID` string, uuid — The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Type` 'BANK' | 'CURRENT' | 'CURRLIAB' | 'DEPRECIATN' | 'DIRECTCOSTS' | 'EQUITY' | 'EXPENSE' | 'FIXED' | 'INVENTORY' | 'LIABILITY' | 'NONCURRENT' | 'OTHERINCOME' | 'OVERHEADS' | 'PREPAYMENT' | 'REVENUE' | 'SALES' | 'TERMLIAB' | 'PAYG' — See Account Types - `BankAccountNumber` string — For bank accounts only (Account Type BANK) - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes - `Description` string — Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000) - `BankAccountType` 'BANK' | 'CREDITCARD' | 'PAYPAL' | 'NONE' | '' — For bank accounts only. See Bank Account types - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `TaxType` string — The tax type from taxRates - `EnablePaymentsToAccount` boolean — Boolean – describes whether account can have payments applied to it - `ShowInExpenseClaims` boolean — Boolean – describes whether account code is available for use with expense claims - `Class` 'ASSET' | 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' — See Account Class Types - `SystemAccount` 'DEBTORS' | 'CREDITORS' | 'BANKCURRENCYGAIN' | 'GST' | 'GSTONIMPORTS' | 'HISTORICAL' | 'REALISEDCURRENCYGAIN' | 'RETAINEDEARNINGS' | 'ROUNDING' | 'TRACKINGTRANSFERS' | 'UNPAIDEXPCLM' | 'UNREALISEDCURRENCYGAIN' | 'WAGEPAYABLES' | 'CISASSETS' | 'CISASSET' | 'CISLABOUR' | 'CISLABOUREXPENSE' | 'CISLABOURINCOME' | 'CISLIABILITY' | 'CISMATERIALS' | '' — If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. - `ReportingCode` string — Shown if set - `ReportingCodeName` string — Shown if set - `HasAttachments` boolean — boolean to indicate if an account has an attachment (read only) - `UpdatedDateUTC` string — Last modified date UTC format - `AddToWatchlist` boolean — Boolean – describes whether the account is shown in the watchlist widget on the dashboard - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Reference` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Particulars` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Code` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Details` string — (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 - `Narrative` string — (UK Only) Only shows on the statement line in Xero. Max length =18 - `BatchPaymentID` string, uuid — The Xero generated unique identifier for the bank transaction (read-only) - `DateString` string — Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 - `Date` string — Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 - `Amount` number, double — The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 - `Payments` Payment[] — An array of payments - `Invoice` Invoice - `Type` 'ACCPAY' | 'ACCPAYCREDIT' | 'APOVERPAYMENT' | 'APPREPAYMENT' | 'ACCREC' | 'ACCRECCREDIT' | 'AROVERPAYMENT' | 'ARPREPAYMENT' — See Invoice Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - `FirstName` string — First name of person - `LastName` string — Last name of person - `EmailAddress` string — Email address of person - `IncludeInEmails` boolean — boolean to indicate whether contact should be included on emails with invoices etc. - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - `AddressType` 'POBOX' | 'STREET' — define the type of address - `AddressLine1` string — max length = 500 - `AddressLine2` string — max length = 500 - `AddressLine3` string — max length = 500 - `AddressLine4` string — max length = 500 - `City` string — max length = 255 - `Region` string — max length = 255 - `PostalCode` string — max length = 50 - `Country` string — max length = 50, [A-Z], [a-z] only - `AttentionTo` string — max length = 255 - `Phones` Phone[] — Store certain phone types for a contact – see phone types - `PhoneType` 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE' - `PhoneNumber` string — max length = 50 - `PhoneAreaCode` string — max length = 10 - `PhoneCountryCode` string — max length = 20 - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - `Bills` Bill - … - `Sales` Bill - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - `Name` string — The Name of the contact group. Required when creating a new contact group - `Status` 'ACTIVE' | 'DELETED' — The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. - `ContactGroupID` string, uuid — The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Contacts` Contact[] — The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - `BrandingThemeID` string, uuid — Xero identifier - `Name` string — Name of branding theme - `LogoUrl` string — The location of the image file used as the logo on this branding theme - `Type` 'INVOICE' — Always INVOICE - `SortOrder` integer — Integer – ranked order of branding theme. The default branding theme has a value of 0 - `CreatedDateUTC` string — UTC timestamp of creation date of branding theme - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - `BankAccountNumber` string — Bank account number for use with Batch Payments - `BankAccountName` string — Name of bank for use with Batch Payments - `Details` string — (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 - `Code` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Reference` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - `AccountsReceivable` AccountsReceivable - … - `AccountsPayable` AccountsPayable - … - `Attachments` Attachment[] — Displays array of attachments from the API - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - `Message` string — Validation error message - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `LineItems` LineItem[] — See LineItems - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - `Code` string — User defined item code (max length = 30) - `Name` string — The name of the item (max length = 50) - `ItemID` string, uuid — The Xero identifier for an Item - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - `TrackingCategoryID` string, uuid — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - `TaxComponentId` string, uuid — The unique ID number of this component - `Type` 'SYSGST/USCOUNTRY' | 'SYSGST/USSTATE' | 'SYSGST/USCOUNTY' | 'SYSGST/USCITY' | 'SYSGST/USSPECIAL' — The type of the jurisdiction - `Name` string — The name of the jurisdiction - `TaxPercentage` number — The percentage of the tax - `TaxAmount` number — The amount of the tax - `TaxableAmount` number — The amount that is taxable - `NonTaxableAmount` number — The amount that is not taxable - `ExemptAmount` number — The amount that is exempt - `StateAssignedNo` string — The state assigned number of the jurisdiction - `JurisdictionRegion` string — Name identifying the region within the country - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `InvoiceNumber` string — ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) - `Reference` string — ACCREC only – additional reference number - `BrandingThemeID` string, uuid — See BrandingThemes - `Url` string — URL link to a source document – shown as “Go to [appName]” in the Xero app - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Invoice Status Codes - `SentToContact` boolean — 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 - `ExpectedPaymentDate` string — Shown on sales invoices (Accounts Receivable) when this has been set - `PlannedPaymentDate` string — Shown on bills (Accounts Payable) when this has been set - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `SubTotal` number, double — Total of invoice excluding taxes - `TotalTax` number, double — Total tax on invoice - `Total` number, double — Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts - `TotalDiscount` number, double — Total of discounts applied on the invoice line items - `InvoiceID` string, uuid — Xero generated unique identifier for invoice - `RepeatingInvoiceID` string, uuid — Xero generated unique identifier for repeating invoices - `HasAttachments` boolean — boolean to indicate if an invoice has an attachment - `IsDiscounted` boolean — boolean to indicate if an invoice has a discount - `Payments` Payment[] — See Payments - `Prepayments` Prepayment[] — See Prepayments - `Type` 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT' | 'ARPREPAYMENT' | 'APPREPAYMENT' — See Prepayment Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - … - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - … - `Phones` Phone[] — Store certain phone types for a contact – see phone types - … - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - … - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - … - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - … - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - … - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - … - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - … - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - … - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — The date the prepayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Prepayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Prepayment Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - … - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - … - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - … - `SubTotal` number, double — The subtotal of the prepayment excluding taxes - `TotalTax` number, double — The total tax on the prepayment - `Total` number, double — The total of the prepayment(subtotal + total tax) - `Reference` string — Returns Invoice number field. Reference field isn't available. - `InvoiceNumber` string — Returns Invoice number for prepayment receive document only. - `UpdatedDateUTC` string — UTC timestamp of last update to the prepayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the prepayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `PrepaymentID` string, uuid — Xero generated unique identifier - `BrandingThemeID` string, uuid — The unique identifier of the branding template applied to a receive prepayment - `CurrencyRate` number, double — The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the prepayment - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required — recursive - `Overpayment` Overpayment - … - `Prepayment` Prepayment — recursive - `CreditNote` CreditNote - … - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Payments` Payment[] — See Payments - `AppliedAmount` number, double — The amount of applied to an invoice - `HasAttachments` boolean — boolean to indicate if a prepayment has an attachment - `Attachments` Attachment[] — See Attachments - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `Overpayments` Overpayment[] — See Overpayments - `Type` 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT' | 'AROVERPAYMENT' — See Overpayment Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - … - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - … - `Phones` Phone[] — Store certain phone types for a contact – see phone types - … - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - … - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - … - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - … - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - … - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - … - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - … - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - … - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — The date the overpayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Overpayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Overpayment Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - … - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - … - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - … - `SubTotal` number, double — The subtotal of the overpayment excluding taxes - `TotalTax` number, double — The total tax on the overpayment - `Total` number, double — The total of the overpayment (subtotal + total tax) - `UpdatedDateUTC` string — UTC timestamp of last update to the overpayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the overpayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `OverpaymentID` string, uuid — Xero generated unique identifier - `CurrencyRate` number, double — The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the overpayment - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required — recursive - `Overpayment` Overpayment — recursive - `Prepayment` Prepayment - … - `CreditNote` CreditNote - … - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `HasAttachments` boolean — boolean to indicate if a overpayment has an attachment - `Reference` string — An optional description for Overpayment - `Attachments` Attachment[] — See Attachments - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `AmountDue` number, double — Amount remaining to be paid on invoice - `AmountPaid` number, double — Sum of payments received for invoice - `FullyPaidOnDate` string — The date the invoice was fully paid. Only returned on fully paid invoices - `AmountCredited` number, double — Sum of all credit notes, over-payments and pre-payments applied to invoice - `UpdatedDateUTC` string — UTC timestamp of last update to the invoice - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the invoice - `CreditNotes` CreditNote[] — Details of credit notes that have been applied to an invoice - `Type` 'ACCPAYCREDIT' | 'ACCRECCREDIT' — See Credit Note Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - … - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - … - `Phones` Phone[] — Store certain phone types for a contact – see phone types - … - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - … - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - … - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - … - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - … - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - … - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - … - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - … - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Credit Note Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Invoice Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - … - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - … - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - … - `SubTotal` number, double — The subtotal of the credit note excluding taxes - `TotalTax` number, double — The total tax on the credit note - `Total` number, double — The total of the Credit Note(subtotal + total tax) - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `UpdatedDateUTC` string — UTC timestamp of last update to the credit note - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the credit note - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `FullyPaidOnDate` string — Date when credit note was fully paid(UTC format) - `CreditNoteID` string, uuid — Xero generated unique identifier - `CreditNoteNumber` string — ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) - `Reference` string — ACCRECCREDIT only – additional reference number - `SentToContact` boolean — 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 - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the Credit Note - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required — recursive - `Overpayment` Overpayment - … - `Prepayment` Prepayment - … - `CreditNote` CreditNote — recursive - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `BrandingThemeID` string, uuid — See BrandingThemes - `StatusAttributeString` string — A string to indicate if a invoice status - `HasAttachments` boolean — boolean to indicate if a credit note has an attachment - `HasErrors` boolean — A boolean to indicate if a credit note has an validation errors - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Warnings` ValidationError[] — Displays array of warning messages from the API - `Message` string — Validation error message - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - `InvoiceAddressType` 'FROM' | 'TO' — Indicates whether the address is defined as origin (FROM) or destination (TO) - `AddressLine1` string — First line of a physical address - `AddressLine2` string — Second line of a physical address - `AddressLine3` string — Third line of a physical address - `AddressLine4` string — Fourth line of a physical address - `City` string — City of a physical address - `Region` string — Region or state of a physical address - `PostalCode` string — Postal code of a physical address - `Country` string — Country of a physical address - `Attachments` Attachment[] — Displays array of attachments from the API - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `HasErrors` boolean — A boolean to indicate if a invoice has an validation errors - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Warnings` ValidationError[] — Displays array of warning messages from the API - `Message` string — Validation error message - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - `InvoiceAddressType` 'FROM' | 'TO' — Indicates whether the address is defined as origin (FROM) or destination (TO) - `AddressLine1` string — First line of a physical address - `AddressLine2` string — Second line of a physical address - `AddressLine3` string — Third line of a physical address - `AddressLine4` string — Fourth line of a physical address - `City` string — City of a physical address - `Region` string — Region or state of a physical address - `PostalCode` string — Postal code of a physical address - `Country` string — Country of a physical address - `CreditNote` CreditNote - `Type` 'ACCPAYCREDIT' | 'ACCRECCREDIT' — See Credit Note Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - `FirstName` string — First name of person - `LastName` string — Last name of person - `EmailAddress` string — Email address of person - `IncludeInEmails` boolean — boolean to indicate whether contact should be included on emails with invoices etc. - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - `AddressType` 'POBOX' | 'STREET' — define the type of address - `AddressLine1` string — max length = 500 - `AddressLine2` string — max length = 500 - `AddressLine3` string — max length = 500 - `AddressLine4` string — max length = 500 - `City` string — max length = 255 - `Region` string — max length = 255 - `PostalCode` string — max length = 50 - `Country` string — max length = 50, [A-Z], [a-z] only - `AttentionTo` string — max length = 255 - `Phones` Phone[] — Store certain phone types for a contact – see phone types - `PhoneType` 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE' - `PhoneNumber` string — max length = 50 - `PhoneAreaCode` string — max length = 10 - `PhoneCountryCode` string — max length = 20 - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - `Bills` Bill - … - `Sales` Bill - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - `Name` string — The Name of the contact group. Required when creating a new contact group - `Status` 'ACTIVE' | 'DELETED' — The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. - `ContactGroupID` string, uuid — The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Contacts` Contact[] — The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - `BrandingThemeID` string, uuid — Xero identifier - `Name` string — Name of branding theme - `LogoUrl` string — The location of the image file used as the logo on this branding theme - `Type` 'INVOICE' — Always INVOICE - `SortOrder` integer — Integer – ranked order of branding theme. The default branding theme has a value of 0 - `CreatedDateUTC` string — UTC timestamp of creation date of branding theme - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - `BankAccountNumber` string — Bank account number for use with Batch Payments - `BankAccountName` string — Name of bank for use with Batch Payments - `Details` string — (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 - `Code` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Reference` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - `AccountsReceivable` AccountsReceivable - … - `AccountsPayable` AccountsPayable - … - `Attachments` Attachment[] — Displays array of attachments from the API - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - `Message` string — Validation error message - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Credit Note Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Invoice Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - `Code` string — User defined item code (max length = 30) - `Name` string — The name of the item (max length = 50) - `ItemID` string, uuid — The Xero identifier for an Item - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - `TrackingCategoryID` string, uuid — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - `TaxComponentId` string, uuid — The unique ID number of this component - `Type` 'SYSGST/USCOUNTRY' | 'SYSGST/USSTATE' | 'SYSGST/USCOUNTY' | 'SYSGST/USCITY' | 'SYSGST/USSPECIAL' — The type of the jurisdiction - `Name` string — The name of the jurisdiction - `TaxPercentage` number — The percentage of the tax - `TaxAmount` number — The amount of the tax - `TaxableAmount` number — The amount that is taxable - `NonTaxableAmount` number — The amount that is not taxable - `ExemptAmount` number — The amount that is exempt - `StateAssignedNo` string — The state assigned number of the jurisdiction - `JurisdictionRegion` string — Name identifying the region within the country - `SubTotal` number, double — The subtotal of the credit note excluding taxes - `TotalTax` number, double — The total tax on the credit note - `Total` number, double — The total of the Credit Note(subtotal + total tax) - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `UpdatedDateUTC` string — UTC timestamp of last update to the credit note - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the credit note - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `FullyPaidOnDate` string — Date when credit note was fully paid(UTC format) - `CreditNoteID` string, uuid — Xero generated unique identifier - `CreditNoteNumber` string — ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) - `Reference` string — ACCRECCREDIT only – additional reference number - `SentToContact` boolean — 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 - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the Credit Note - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required - `Type` 'ACCPAY' | 'ACCPAYCREDIT' | 'APOVERPAYMENT' | 'APPREPAYMENT' | 'ACCREC' | 'ACCRECCREDIT' | 'AROVERPAYMENT' | 'ARPREPAYMENT' — See Invoice Types - `Contact` Contact - … - `LineItems` LineItem[] — See LineItems - … - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `InvoiceNumber` string — ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) - `Reference` string — ACCREC only – additional reference number - `BrandingThemeID` string, uuid — See BrandingThemes - `Url` string — URL link to a source document – shown as “Go to [appName]” in the Xero app - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Invoice Status Codes - `SentToContact` boolean — 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 - `ExpectedPaymentDate` string — Shown on sales invoices (Accounts Receivable) when this has been set - `PlannedPaymentDate` string — Shown on bills (Accounts Payable) when this has been set - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `SubTotal` number, double — Total of invoice excluding taxes - `TotalTax` number, double — Total tax on invoice - `Total` number, double — Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts - `TotalDiscount` number, double — Total of discounts applied on the invoice line items - `InvoiceID` string, uuid — Xero generated unique identifier for invoice - `RepeatingInvoiceID` string, uuid — Xero generated unique identifier for repeating invoices - `HasAttachments` boolean — boolean to indicate if an invoice has an attachment - `IsDiscounted` boolean — boolean to indicate if an invoice has a discount - `Payments` Payment[] — See Payments - `Prepayments` Prepayment[] — See Prepayments - … - `Overpayments` Overpayment[] — See Overpayments - … - `AmountDue` number, double — Amount remaining to be paid on invoice - `AmountPaid` number, double — Sum of payments received for invoice - `FullyPaidOnDate` string — The date the invoice was fully paid. Only returned on fully paid invoices - `AmountCredited` number, double — Sum of all credit notes, over-payments and pre-payments applied to invoice - `UpdatedDateUTC` string — UTC timestamp of last update to the invoice - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the invoice - `CreditNotes` CreditNote[] — Details of credit notes that have been applied to an invoice - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasErrors` boolean — A boolean to indicate if a invoice has an validation errors - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Warnings` ValidationError[] — Displays array of warning messages from the API - … - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - … - `Overpayment` Overpayment - `Type` 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT' | 'AROVERPAYMENT' — See Overpayment Types - `Contact` Contact - … - `Date` string — The date the overpayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Overpayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Overpayment Line Items - … - `SubTotal` number, double — The subtotal of the overpayment excluding taxes - `TotalTax` number, double — The total tax on the overpayment - `Total` number, double — The total of the overpayment (subtotal + total tax) - `UpdatedDateUTC` string — UTC timestamp of last update to the overpayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the overpayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `OverpaymentID` string, uuid — Xero generated unique identifier - `CurrencyRate` number, double — The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the overpayment - `Allocations` Allocation[] — See Allocations - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `HasAttachments` boolean — boolean to indicate if a overpayment has an attachment - `Reference` string — An optional description for Overpayment - `Attachments` Attachment[] — See Attachments - … - `Prepayment` Prepayment - `Type` 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT' | 'ARPREPAYMENT' | 'APPREPAYMENT' — See Prepayment Types - `Contact` Contact - … - `Date` string — The date the prepayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Prepayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Prepayment Line Items - … - `SubTotal` number, double — The subtotal of the prepayment excluding taxes - `TotalTax` number, double — The total tax on the prepayment - `Total` number, double — The total of the prepayment(subtotal + total tax) - `Reference` string — Returns Invoice number field. Reference field isn't available. - `InvoiceNumber` string — Returns Invoice number for prepayment receive document only. - `UpdatedDateUTC` string — UTC timestamp of last update to the prepayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the prepayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `PrepaymentID` string, uuid — Xero generated unique identifier - `BrandingThemeID` string, uuid — The unique identifier of the branding template applied to a receive prepayment - `CurrencyRate` number, double — The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the prepayment - `Allocations` Allocation[] — See Allocations - `Payments` Payment[] — See Payments - `AppliedAmount` number, double — The amount of applied to an invoice - `HasAttachments` boolean — boolean to indicate if a prepayment has an attachment - `Attachments` Attachment[] — See Attachments - … - `CreditNote` CreditNote — recursive - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `BrandingThemeID` string, uuid — See BrandingThemes - `StatusAttributeString` string — A string to indicate if a invoice status - `HasAttachments` boolean — boolean to indicate if a credit note has an attachment - `HasErrors` boolean — A boolean to indicate if a credit note has an validation errors - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Warnings` ValidationError[] — Displays array of warning messages from the API - `Message` string — Validation error message - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - `InvoiceAddressType` 'FROM' | 'TO' — Indicates whether the address is defined as origin (FROM) or destination (TO) - `AddressLine1` string — First line of a physical address - `AddressLine2` string — Second line of a physical address - `AddressLine3` string — Third line of a physical address - `AddressLine4` string — Fourth line of a physical address - `City` string — City of a physical address - `Region` string — Region or state of a physical address - `PostalCode` string — Postal code of a physical address - `Country` string — Country of a physical address - `Prepayment` Prepayment - `Type` 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT' | 'ARPREPAYMENT' | 'APPREPAYMENT' — See Prepayment Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - `FirstName` string — First name of person - `LastName` string — Last name of person - `EmailAddress` string — Email address of person - `IncludeInEmails` boolean — boolean to indicate whether contact should be included on emails with invoices etc. - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - `AddressType` 'POBOX' | 'STREET' — define the type of address - `AddressLine1` string — max length = 500 - `AddressLine2` string — max length = 500 - `AddressLine3` string — max length = 500 - `AddressLine4` string — max length = 500 - `City` string — max length = 255 - `Region` string — max length = 255 - `PostalCode` string — max length = 50 - `Country` string — max length = 50, [A-Z], [a-z] only - `AttentionTo` string — max length = 255 - `Phones` Phone[] — Store certain phone types for a contact – see phone types - `PhoneType` 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE' - `PhoneNumber` string — max length = 50 - `PhoneAreaCode` string — max length = 10 - `PhoneCountryCode` string — max length = 20 - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - `Bills` Bill - … - `Sales` Bill - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - `Name` string — The Name of the contact group. Required when creating a new contact group - `Status` 'ACTIVE' | 'DELETED' — The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. - `ContactGroupID` string, uuid — The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Contacts` Contact[] — The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - `BrandingThemeID` string, uuid — Xero identifier - `Name` string — Name of branding theme - `LogoUrl` string — The location of the image file used as the logo on this branding theme - `Type` 'INVOICE' — Always INVOICE - `SortOrder` integer — Integer – ranked order of branding theme. The default branding theme has a value of 0 - `CreatedDateUTC` string — UTC timestamp of creation date of branding theme - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - `BankAccountNumber` string — Bank account number for use with Batch Payments - `BankAccountName` string — Name of bank for use with Batch Payments - `Details` string — (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 - `Code` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Reference` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - `AccountsReceivable` AccountsReceivable - … - `AccountsPayable` AccountsPayable - … - `Attachments` Attachment[] — Displays array of attachments from the API - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - `Message` string — Validation error message - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — The date the prepayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Prepayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Prepayment Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - `Code` string — User defined item code (max length = 30) - `Name` string — The name of the item (max length = 50) - `ItemID` string, uuid — The Xero identifier for an Item - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - `TrackingCategoryID` string, uuid — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - `TaxComponentId` string, uuid — The unique ID number of this component - `Type` 'SYSGST/USCOUNTRY' | 'SYSGST/USSTATE' | 'SYSGST/USCOUNTY' | 'SYSGST/USCITY' | 'SYSGST/USSPECIAL' — The type of the jurisdiction - `Name` string — The name of the jurisdiction - `TaxPercentage` number — The percentage of the tax - `TaxAmount` number — The amount of the tax - `TaxableAmount` number — The amount that is taxable - `NonTaxableAmount` number — The amount that is not taxable - `ExemptAmount` number — The amount that is exempt - `StateAssignedNo` string — The state assigned number of the jurisdiction - `JurisdictionRegion` string — Name identifying the region within the country - `SubTotal` number, double — The subtotal of the prepayment excluding taxes - `TotalTax` number, double — The total tax on the prepayment - `Total` number, double — The total of the prepayment(subtotal + total tax) - `Reference` string — Returns Invoice number field. Reference field isn't available. - `InvoiceNumber` string — Returns Invoice number for prepayment receive document only. - `UpdatedDateUTC` string — UTC timestamp of last update to the prepayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the prepayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `PrepaymentID` string, uuid — Xero generated unique identifier - `BrandingThemeID` string, uuid — The unique identifier of the branding template applied to a receive prepayment - `CurrencyRate` number, double — The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the prepayment - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required - `Type` 'ACCPAY' | 'ACCPAYCREDIT' | 'APOVERPAYMENT' | 'APPREPAYMENT' | 'ACCREC' | 'ACCRECCREDIT' | 'AROVERPAYMENT' | 'ARPREPAYMENT' — See Invoice Types - `Contact` Contact - … - `LineItems` LineItem[] — See LineItems - … - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `InvoiceNumber` string — ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) - `Reference` string — ACCREC only – additional reference number - `BrandingThemeID` string, uuid — See BrandingThemes - `Url` string — URL link to a source document – shown as “Go to [appName]” in the Xero app - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Invoice Status Codes - `SentToContact` boolean — 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 - `ExpectedPaymentDate` string — Shown on sales invoices (Accounts Receivable) when this has been set - `PlannedPaymentDate` string — Shown on bills (Accounts Payable) when this has been set - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `SubTotal` number, double — Total of invoice excluding taxes - `TotalTax` number, double — Total tax on invoice - `Total` number, double — Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts - `TotalDiscount` number, double — Total of discounts applied on the invoice line items - `InvoiceID` string, uuid — Xero generated unique identifier for invoice - `RepeatingInvoiceID` string, uuid — Xero generated unique identifier for repeating invoices - `HasAttachments` boolean — boolean to indicate if an invoice has an attachment - `IsDiscounted` boolean — boolean to indicate if an invoice has a discount - `Payments` Payment[] — See Payments - `Prepayments` Prepayment[] — See Prepayments - `Overpayments` Overpayment[] — See Overpayments - … - `AmountDue` number, double — Amount remaining to be paid on invoice - `AmountPaid` number, double — Sum of payments received for invoice - `FullyPaidOnDate` string — The date the invoice was fully paid. Only returned on fully paid invoices - `AmountCredited` number, double — Sum of all credit notes, over-payments and pre-payments applied to invoice - `UpdatedDateUTC` string — UTC timestamp of last update to the invoice - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the invoice - `CreditNotes` CreditNote[] — Details of credit notes that have been applied to an invoice - … - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasErrors` boolean — A boolean to indicate if a invoice has an validation errors - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Warnings` ValidationError[] — Displays array of warning messages from the API - … - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - … - `Overpayment` Overpayment - `Type` 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT' | 'AROVERPAYMENT' — See Overpayment Types - `Contact` Contact - … - `Date` string — The date the overpayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Overpayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Overpayment Line Items - … - `SubTotal` number, double — The subtotal of the overpayment excluding taxes - `TotalTax` number, double — The total tax on the overpayment - `Total` number, double — The total of the overpayment (subtotal + total tax) - `UpdatedDateUTC` string — UTC timestamp of last update to the overpayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the overpayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `OverpaymentID` string, uuid — Xero generated unique identifier - `CurrencyRate` number, double — The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the overpayment - `Allocations` Allocation[] — See Allocations - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `HasAttachments` boolean — boolean to indicate if a overpayment has an attachment - `Reference` string — An optional description for Overpayment - `Attachments` Attachment[] — See Attachments - … - `Prepayment` Prepayment — recursive - `CreditNote` CreditNote - `Type` 'ACCPAYCREDIT' | 'ACCRECCREDIT' — See Credit Note Types - `Contact` Contact - … - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Credit Note Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Invoice Line Items - … - `SubTotal` number, double — The subtotal of the credit note excluding taxes - `TotalTax` number, double — The total tax on the credit note - `Total` number, double — The total of the Credit Note(subtotal + total tax) - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `UpdatedDateUTC` string — UTC timestamp of last update to the credit note - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the credit note - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `FullyPaidOnDate` string — Date when credit note was fully paid(UTC format) - `CreditNoteID` string, uuid — Xero generated unique identifier - `CreditNoteNumber` string — ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) - `Reference` string — ACCRECCREDIT only – additional reference number - `SentToContact` boolean — 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 - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the Credit Note - `Allocations` Allocation[] — See Allocations - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `BrandingThemeID` string, uuid — See BrandingThemes - `StatusAttributeString` string — A string to indicate if a invoice status - `HasAttachments` boolean — boolean to indicate if a credit note has an attachment - `HasErrors` boolean — A boolean to indicate if a credit note has an validation errors - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Warnings` ValidationError[] — Displays array of warning messages from the API - … - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - … - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Payments` Payment[] — See Payments - `AppliedAmount` number, double — The amount of applied to an invoice - `HasAttachments` boolean — boolean to indicate if a prepayment has an attachment - `Attachments` Attachment[] — See Attachments - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `Overpayment` Overpayment - `Type` 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT' | 'AROVERPAYMENT' — See Overpayment Types - `Contact` Contact - `ContactID` string, uuid — Xero identifier - `MergedToContactID` string, uuid — ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. - `ContactNumber` string — This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. - `AccountNumber` string — A user defined account number. This can be updated via the API and the Xero UI (max length = 50) - `ContactStatus` 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST' — Current status of a contact – see contact status types - `Name` string — Full name of contact/organisation (max length = 255) - `FirstName` string — First name of contact person (max length = 255) - `LastName` string — Last name of contact person (max length = 255) - `CompanyNumber` string — Company registration number (max length = 50) - `EmailAddress` string — Email address of contact person (umlauts not supported) (max length = 255) - `ContactPersons` ContactPerson[] — See contact persons - `FirstName` string — First name of person - `LastName` string — Last name of person - `EmailAddress` string — Email address of person - `IncludeInEmails` boolean — boolean to indicate whether contact should be included on emails with invoices etc. - `BankAccountDetails` string — Bank account number of contact - `TaxNumber` string — Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) - `TaxNumberType` 'SSN' | 'EIN' | 'ITIN' | 'ATIN' — Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers - `AccountsReceivableTaxType` string — The tax type from TaxRates - `AccountsPayableTaxType` string — The tax type from TaxRates - `Addresses` Address[] — Store certain address types for a contact – see address types - `AddressType` 'POBOX' | 'STREET' — define the type of address - `AddressLine1` string — max length = 500 - `AddressLine2` string — max length = 500 - `AddressLine3` string — max length = 500 - `AddressLine4` string — max length = 500 - `City` string — max length = 255 - `Region` string — max length = 255 - `PostalCode` string — max length = 50 - `Country` string — max length = 50, [A-Z], [a-z] only - `AttentionTo` string — max length = 255 - `Phones` Phone[] — Store certain phone types for a contact – see phone types - `PhoneType` 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE' - `PhoneNumber` string — max length = 50 - `PhoneAreaCode` string — max length = 10 - `PhoneCountryCode` string — max length = 20 - `IsSupplier` boolean — true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. - `IsCustomer` boolean — true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. - `SalesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `PurchasesDefaultLineAmountType` 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE' — The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. - `DefaultCurrency` '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' — 3 letter alpha code for the currency – see list of currency codes - `XeroNetworkKey` string — Store XeroNetworkKey for contacts. - `SalesDefaultAccountCode` string — The default sales account code for contacts - `PurchasesDefaultAccountCode` string — The default purchases account code for contacts - `SalesTrackingCategories` SalesTrackingCategory[] — The default sales tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `PurchasesTrackingCategories` SalesTrackingCategory[] — The default purchases tracking categories for contacts - `TrackingCategoryName` string — The default sales tracking category name for contacts - `TrackingOptionName` string — The default purchase tracking category name for contacts - `TrackingCategoryName` string — The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `TrackingCategoryOption` string — The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories - `PaymentTerms` PaymentTerm - `Bills` Bill - … - `Sales` Bill - … - `UpdatedDateUTC` string — UTC timestamp of last update to contact - `ContactGroups` ContactGroup[] — Displays which contact groups a contact is included in - `Name` string — The Name of the contact group. Required when creating a new contact group - `Status` 'ACTIVE' | 'DELETED' — The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. - `ContactGroupID` string, uuid — The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Contacts` Contact[] — The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. - `Website` string — Website address for contact (read only) - `BrandingTheme` BrandingTheme - `BrandingThemeID` string, uuid — Xero identifier - `Name` string — Name of branding theme - `LogoUrl` string — The location of the image file used as the logo on this branding theme - `Type` 'INVOICE' — Always INVOICE - `SortOrder` integer — Integer – ranked order of branding theme. The default branding theme has a value of 0 - `CreatedDateUTC` string — UTC timestamp of creation date of branding theme - `BatchPayments` BatchPaymentDetails — Bank details for use on a batch payment stored with each contact - `BankAccountNumber` string — Bank account number for use with Batch Payments - `BankAccountName` string — Name of bank for use with Batch Payments - `Details` string — (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 - `Code` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Reference` string — (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. - `Discount` number, double — The default discount rate for the contact (read only) - `Balances` Balances — The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) - `AccountsReceivable` AccountsReceivable - … - `AccountsPayable` AccountsPayable - … - `Attachments` Attachment[] — Displays array of attachments from the API - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `HasAttachments` boolean — A boolean to indicate if a contact has an attachment - `ValidationErrors` ValidationError[] — Displays validation errors returned from the API - `Message` string — Validation error message - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — Status of object - `Date` string — The date the overpayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Overpayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Overpayment Line Items - `LineItemID` string, uuid — LineItem unique ID - `Description` string — 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 element that contains at least 1 character - `Quantity` number, double — LineItem Quantity - `UnitAmount` number, double — LineItem Unit Amount - `ItemCode` string — See Items - `AccountCode` string — See Accounts - `AccountID` string, uuid — The associated account ID related to this line item - `TaxType` string — The tax type from TaxRates - `TaxAmount` number, double — 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 is not correct. - `Item` LineItemItem - `Code` string — User defined item code (max length = 30) - `Name` string — The name of the item (max length = 50) - `ItemID` string, uuid — The Xero identifier for an Item - `LineAmount` number, double — 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 - `Tracking` LineItemTracking[] — Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. - `TrackingCategoryID` string, uuid — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `DiscountRate` number, double — 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 - `DiscountAmount` number, double — 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. - `RepeatingInvoiceID` string, uuid — The Xero identifier for a Repeating Invoice - `Taxability` 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE' — The type of taxability - `SalesTaxCodeId` number — The ID of the sales tax code - `TaxBreakdown` TaxBreakdownComponent[] — An array of tax components defined for this line item - `TaxComponentId` string, uuid — The unique ID number of this component - `Type` 'SYSGST/USCOUNTRY' | 'SYSGST/USSTATE' | 'SYSGST/USCOUNTY' | 'SYSGST/USCITY' | 'SYSGST/USSPECIAL' — The type of the jurisdiction - `Name` string — The name of the jurisdiction - `TaxPercentage` number — The percentage of the tax - `TaxAmount` number — The amount of the tax - `TaxableAmount` number — The amount that is taxable - `NonTaxableAmount` number — The amount that is not taxable - `ExemptAmount` number — The amount that is exempt - `StateAssignedNo` string — The state assigned number of the jurisdiction - `JurisdictionRegion` string — Name identifying the region within the country - `SubTotal` number, double — The subtotal of the overpayment excluding taxes - `TotalTax` number, double — The total tax on the overpayment - `Total` number, double — The total of the overpayment (subtotal + total tax) - `UpdatedDateUTC` string — UTC timestamp of last update to the overpayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the overpayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `OverpaymentID` string, uuid — Xero generated unique identifier - `CurrencyRate` number, double — The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the overpayment - `Allocations` Allocation[] — See Allocations - `AllocationID` string, uuid — Xero generated unique identifier - `Invoice` Invoice, required - `Type` 'ACCPAY' | 'ACCPAYCREDIT' | 'APOVERPAYMENT' | 'APPREPAYMENT' | 'ACCREC' | 'ACCRECCREDIT' | 'AROVERPAYMENT' | 'ARPREPAYMENT' — See Invoice Types - `Contact` Contact - … - `LineItems` LineItem[] — See LineItems - … - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `InvoiceNumber` string — ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) - `Reference` string — ACCREC only – additional reference number - `BrandingThemeID` string, uuid — See BrandingThemes - `Url` string — URL link to a source document – shown as “Go to [appName]” in the Xero app - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Invoice Status Codes - `SentToContact` boolean — 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 - `ExpectedPaymentDate` string — Shown on sales invoices (Accounts Receivable) when this has been set - `PlannedPaymentDate` string — Shown on bills (Accounts Payable) when this has been set - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `SubTotal` number, double — Total of invoice excluding taxes - `TotalTax` number, double — Total tax on invoice - `Total` number, double — Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts - `TotalDiscount` number, double — Total of discounts applied on the invoice line items - `InvoiceID` string, uuid — Xero generated unique identifier for invoice - `RepeatingInvoiceID` string, uuid — Xero generated unique identifier for repeating invoices - `HasAttachments` boolean — boolean to indicate if an invoice has an attachment - `IsDiscounted` boolean — boolean to indicate if an invoice has a discount - `Payments` Payment[] — See Payments - `Prepayments` Prepayment[] — See Prepayments - … - `Overpayments` Overpayment[] — See Overpayments - `AmountDue` number, double — Amount remaining to be paid on invoice - `AmountPaid` number, double — Sum of payments received for invoice - `FullyPaidOnDate` string — The date the invoice was fully paid. Only returned on fully paid invoices - `AmountCredited` number, double — Sum of all credit notes, over-payments and pre-payments applied to invoice - `UpdatedDateUTC` string — UTC timestamp of last update to the invoice - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the invoice - `CreditNotes` CreditNote[] — Details of credit notes that have been applied to an invoice - … - `Attachments` Attachment[] — Displays array of attachments from the API - … - `HasErrors` boolean — A boolean to indicate if a invoice has an validation errors - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Warnings` ValidationError[] — Displays array of warning messages from the API - … - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - … - `Overpayment` Overpayment — recursive - `Prepayment` Prepayment - `Type` 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT' | 'ARPREPAYMENT' | 'APPREPAYMENT' — See Prepayment Types - `Contact` Contact - … - `Date` string — The date the prepayment is created YYYY-MM-DD - `Status` 'AUTHORISED' | 'PAID' | 'VOIDED' — See Prepayment Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Prepayment Line Items - … - `SubTotal` number, double — The subtotal of the prepayment excluding taxes - `TotalTax` number, double — The total tax on the prepayment - `Total` number, double — The total of the prepayment(subtotal + total tax) - `Reference` string — Returns Invoice number field. Reference field isn't available. - `InvoiceNumber` string — Returns Invoice number for prepayment receive document only. - `UpdatedDateUTC` string — UTC timestamp of last update to the prepayment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the prepayment - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `PrepaymentID` string, uuid — Xero generated unique identifier - `BrandingThemeID` string, uuid — The unique identifier of the branding template applied to a receive prepayment - `CurrencyRate` number, double — The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the prepayment - `Allocations` Allocation[] — See Allocations - `Payments` Payment[] — See Payments - `AppliedAmount` number, double — The amount of applied to an invoice - `HasAttachments` boolean — boolean to indicate if a prepayment has an attachment - `Attachments` Attachment[] — See Attachments - … - `CreditNote` CreditNote - `Type` 'ACCPAYCREDIT' | 'ACCRECCREDIT' — See Credit Note Types - `Contact` Contact - … - `Date` string — 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 — Date invoice is due – YYYY-MM-DD - `Status` 'DRAFT' | 'SUBMITTED' | 'DELETED' | 'AUTHORISED' | 'PAID' | 'VOIDED' — See Credit Note Status Codes - `LineAmountTypes` 'Exclusive' | 'Inclusive' | 'NoTax' — Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types - `LineItems` LineItem[] — See Invoice Line Items - … - `SubTotal` number, double — The subtotal of the credit note excluding taxes - `TotalTax` number, double — The total tax on the credit note - `Total` number, double — The total of the Credit Note(subtotal + total tax) - `CISDeduction` number, double — CIS deduction for UK contractors - `CISRate` number, double — CIS Deduction rate for the organisation - `UpdatedDateUTC` string — UTC timestamp of last update to the credit note - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the credit note - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `FullyPaidOnDate` string — Date when credit note was fully paid(UTC format) - `CreditNoteID` string, uuid — Xero generated unique identifier - `CreditNoteNumber` string — ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) - `Reference` string — ACCRECCREDIT only – additional reference number - `SentToContact` boolean — 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 - `CurrencyRate` number, double — The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used - `RemainingCredit` number, double — The remaining credit balance on the Credit Note - `Allocations` Allocation[] — See Allocations - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `BrandingThemeID` string, uuid — See BrandingThemes - `StatusAttributeString` string — A string to indicate if a invoice status - `HasAttachments` boolean — boolean to indicate if a credit note has an attachment - `HasErrors` boolean — A boolean to indicate if a credit note has an validation errors - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - … - `Warnings` ValidationError[] — Displays array of warning messages from the API - … - `InvoiceAddresses` InvoiceAddress[] — An array of addresses used to auto calculate sales tax - … - `Amount` number, double, required — the amount being applied to the invoice - `Date` string, required — the date the allocation is applied YYYY-MM-DD. - `IsDeleted` boolean — A flag that returns true when the allocation is succesfully deleted - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `AppliedAmount` number, double — The amount of applied to an invoice - `Payments` Payment[] — See Payments - `HasAttachments` boolean — boolean to indicate if a overpayment has an attachment - `Reference` string — An optional description for Overpayment - `Attachments` Attachment[] — See Attachments - `AttachmentID` string, uuid — Unique ID for the file - `FileName` string — Name of the file - `Url` string — URL to the file on xero.com - `MimeType` string — Type of file - `ContentLength` integer — Length of the file content - `IncludeOnline` boolean — Include the file with the online invoice - `InvoiceNumber` string — Number of invoice or credit note you are applying payment to e.g.INV-4003 - `CreditNoteNumber` string — Number of invoice or credit note you are applying payment to e.g. INV-4003 - `BatchPayment` BatchPayment — recursive - `Account` Account - `Code` string — Customer defined alpha numeric account code e.g 200 or SALES (max length = 10) - `Name` string — Name of account (max length = 150) - `AccountID` string, uuid — The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Type` 'BANK' | 'CURRENT' | 'CURRLIAB' | 'DEPRECIATN' | 'DIRECTCOSTS' | 'EQUITY' | 'EXPENSE' | 'FIXED' | 'INVENTORY' | 'LIABILITY' | 'NONCURRENT' | 'OTHERINCOME' | 'OVERHEADS' | 'PREPAYMENT' | 'REVENUE' | 'SALES' | 'TERMLIAB' | 'PAYG' — See Account Types - `BankAccountNumber` string — For bank accounts only (Account Type BANK) - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes - `Description` string — Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000) - `BankAccountType` 'BANK' | 'CREDITCARD' | 'PAYPAL' | 'NONE' | '' — For bank accounts only. See Bank Account types - `CurrencyCode` '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' — 3 letter alpha code for the currency – see list of currency codes - `TaxType` string — The tax type from taxRates - `EnablePaymentsToAccount` boolean — Boolean – describes whether account can have payments applied to it - `ShowInExpenseClaims` boolean — Boolean – describes whether account code is available for use with expense claims - `Class` 'ASSET' | 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' — See Account Class Types - `SystemAccount` 'DEBTORS' | 'CREDITORS' | 'BANKCURRENCYGAIN' | 'GST' | 'GSTONIMPORTS' | 'HISTORICAL' | 'REALISEDCURRENCYGAIN' | 'RETAINEDEARNINGS' | 'ROUNDING' | 'TRACKINGTRANSFERS' | 'UNPAIDEXPCLM' | 'UNREALISEDCURRENCYGAIN' | 'WAGEPAYABLES' | 'CISASSETS' | 'CISASSET' | 'CISLABOUR' | 'CISLABOUREXPENSE' | 'CISLABOURINCOME' | 'CISLIABILITY' | 'CISMATERIALS' | '' — If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. - `ReportingCode` string — Shown if set - `ReportingCodeName` string — Shown if set - `HasAttachments` boolean — boolean to indicate if an account has an attachment (read only) - `UpdatedDateUTC` string — Last modified date UTC format - `AddToWatchlist` boolean — Boolean – describes whether the account is shown in the watchlist widget on the dashboard - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Code` string — Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) - `Date` string — Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 - `CurrencyRate` number, double — Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 - `Amount` number, double — The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 - `BankAmount` number, double — The amount of the payment in the currency of the bank account. - `Reference` string — An optional description for the payment e.g. Direct Debit - `IsReconciled` boolean — 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 - `Status` 'AUTHORISED' | 'DELETED' — The status of the payment. - `PaymentType` 'ACCRECPAYMENT' | 'ACCPAYPAYMENT' | 'ARCREDITPAYMENT' | 'APCREDITPAYMENT' | 'AROVERPAYMENTPAYMENT' | 'ARPREPAYMENTPAYMENT' | 'APPREPAYMENTPAYMENT' | 'APOVERPAYMENTPAYMENT' — See Payment Types. - `UpdatedDateUTC` string — UTC timestamp of last update to the payment - `UpdatedDateUTCString` string — UTC ISO-8601 formatted timestamp of last update to the payment - `PaymentID` string, uuid — The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `BatchPaymentID` string, uuid — Present if the payment was created as part of a batch. - `BankAccountNumber` string — The suppliers bank account number the payment is being made to - `Particulars` string — The suppliers bank account number the payment is being made to - `Details` string — The information to appear on the supplier's bank account - `HasAccount` boolean — A boolean to indicate if a contact has an validation errors - `HasValidationErrors` boolean — A boolean to indicate if a contact has an validation errors - `StatusAttributeString` string — A string to indicate if a invoice status - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Warnings` ValidationError[] — Displays array of warning messages from the API - `Message` string — Validation error message - `Type` 'PAYBATCH' | 'RECBATCH' — PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) - `Status` 'AUTHORISED' | 'DELETED' — AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. - `TotalAmount` number, double — The total of the payments that make up the batch (read-only) - `UpdatedDateUTC` string — UTC timestamp of last update to the payment - `IsReconciled` boolean — Booelan that tells you if the batch payment has been reconciled (read-only) - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message ## Other responses - `400` — A failed request due to validation error --- [API](https://skmtc.net/xeroapi/apis/xero-accounting-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-accounting-api/versions/dc231cafd8de/schema)