InvoiceReminder
{
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "setting for on or off"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/invoice-reminders/"
}
}
InvoiceReminders
{
"type": "object",
"properties": {
"InvoiceReminders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceReminder"
}
}
},
"x-isObjectArray": true
}
Invoices
{
"type": "object",
"properties": {
"Invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
},
"x-isObjectArray": true
}
Item
{
"type": "object",
"required": [
"Code"
],
"properties": {
"Code": {
"type": "string",
"maxLength": 30,
"description": "User defined item code (max length = 30)"
},
"Name": {
"type": "string",
"maxLength": 50,
"description": "The name of the item (max length = 50)"
},
"IsSold": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled."
},
"ItemID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Item"
},
"Description": {
"type": "string",
"maxLength": 4000,
"description": "The sales description of the item (max length = 4000)"
},
"IsPurchased": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled."
},
"SalesDetails": {
"$ref": "#/components/schemas/Purchase"
},
"TotalCostPool": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The value of the item on hand. Calculated using average cost accounting."
},
"QuantityOnHand": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The quantity of the item on hand"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Last modified date in UTC format",
"x-is-msdate-time": true
},
"PurchaseDetails": {
"$ref": "#/components/schemas/Purchase"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"PurchaseDescription": {
"type": "string",
"maxLength": 4000,
"description": "The purchase description of the item (max length = 4000)"
},
"IsTrackedAsInventory": {
"type": "boolean",
"description": "True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set."
},
"StatusAttributeString": {
"type": "string",
"description": "Status of object"
},
"InventoryAssetAccountCode": {
"type": "string",
"description": "The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/items/"
}
}
Items
{
"type": "object",
"properties": {
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
}
}
},
"x-isObjectArray": true
}
Journal
{
"type": "object",
"properties": {
"SourceID": {
"type": "string",
"format": "uuid",
"description": "The identifier for the source transaction (e.g. InvoiceID)"
},
"JournalID": {
"type": "string",
"format": "uuid",
"description": "Xero identifier"
},
"Reference": {
"type": "string",
"description": "reference field for additional indetifying information"
},
"SourceType": {
"enum": [
"ACCREC",
"ACCPAY",
"ACCRECCREDIT",
"ACCPAYCREDIT",
"ACCRECPAYMENT",
"ACCPAYPAYMENT",
"ARCREDITPAYMENT",
"APCREDITPAYMENT",
"CASHREC",
"CASHPAID",
"TRANSFER",
"ARPREPAYMENT",
"APPREPAYMENT",
"AROVERPAYMENT",
"APOVERPAYMENT",
"EXPCLAIM",
"EXPPAYMENT",
"MANJOURNAL",
"PAYSLIP",
"WAGEPAYABLE",
"INTEGRATEDPAYROLLPE",
"INTEGRATEDPAYROLLPT",
"EXTERNALSPENDMONEY",
"INTEGRATEDPAYROLLPTPAYMENT",
"INTEGRATEDPAYROLLCN"
],
"type": "string",
"description": "The journal source type. The type of transaction that created the journal"
},
"JournalDate": {
"type": "string",
"description": "Date the journal was posted",
"x-is-msdate": true
},
"JournalLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalLine"
},
"description": "See JournalLines"
},
"JournalNumber": {
"type": "integer",
"description": "Xero generated journal number"
},
"CreatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Created date UTC format",
"x-is-msdate-time": true
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/journals/"
}
}
JournalLine
{
"type": "object",
"properties": {
"TaxName": {
"type": "string",
"example": "Tax Exempt",
"description": "see TaxRates"
},
"TaxType": {
"type": "string",
"description": "The tax type from taxRates"
},
"AccountID": {
"type": "string",
"format": "uuid",
"example": "ceef66a5-a545-413b-9312-78a53caadbc4",
"description": "See Accounts"
},
"NetAmount": {
"type": "number",
"format": "double",
"example": 4130.98,
"x-is-money": true,
"description": "Net amount of journal line. This will be a positive value for a debit and negative for a credit"
},
"TaxAmount": {
"type": "number",
"format": "double",
"example": 0,
"readOnly": true,
"x-is-money": true,
"description": "Total tax on a journal line"
},
"AccountCode": {
"type": "string",
"example": 90,
"description": "See Accounts"
},
"AccountName": {
"type": "string",
"example": "Checking Account",
"description": "See AccountCodes"
},
"AccountType": {
"$ref": "#/components/schemas/AccountType",
"type": "string"
},
"Description": {
"type": "string",
"example": "My business checking account",
"description": "The description from the source transaction line item. Only returned if populated."
},
"GrossAmount": {
"type": "number",
"format": "double",
"example": 4130.98,
"x-is-money": true,
"description": "Gross amount of journal line (NetAmount + TaxAmount)."
},
"JournalLineID": {
"type": "string",
"format": "uuid",
"example": "7be9db36-3598-4755-ba5c-c2dbc8c4a7a2",
"description": "Xero identifier for Journal"
},
"TrackingCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingCategory"
},
"description": "Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements."
}
},
"externalDocs": {
"url": "https://developer.xero.com/documentation/api/journals#JournalLines"
}
}
Journals
{
"type": "object",
"properties": {
"Journals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Journal"
}
}
},
"x-isObjectArray": true
}
LineAmountTypes
{
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
}
LineItem
{
"type": "object",
"properties": {
"Item": {
"$ref": "#/components/schemas/LineItemItem"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"Quantity": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "LineItem Quantity"
},
"Tracking": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItemTracking"
},
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"AccountID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The associated account ID related to this line item"
},
"TaxAmount": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"LineAmount": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "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"
},
"LineItemID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "LineItem unique ID"
},
"UnitAmount": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "LineItem Unit Amount"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"DiscountRate": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "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": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "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": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The Xero identifier for a Repeating Invoice"
}
},
"externalDocs": {
"url": "https://developer.xero.com/documentation/api/invoices#post"
}
}
LineItemItem
{
"properties": {
"Code": {
"type": "string",
"maxLength": 30,
"description": "User defined item code (max length = 30)"
},
"Name": {
"type": "string",
"maxLength": 50,
"description": "The name of the item (max length = 50)"
},
"ItemID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Item"
}
}
}
LineItemTracking
{
"type": "object",
"properties": {
"Name": {
"type": "string",
"example": "Region",
"maxLength": 100,
"description": "The name of the tracking category"
},
"Option": {
"type": "string",
"example": "North",
"description": "See Tracking Options"
},
"TrackingOptionID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The Xero identifier for a tracking category option"
},
"TrackingCategoryID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The Xero identifier for a tracking category"
}
},
"externalDocs": {
"url": "https://developer.xero.com/documentation/api/invoices#post"
}
}
LinkedTransaction
{
"type": "object",
"properties": {
"Type": {
"enum": [
"BILLABLEEXPENSE"
],
"type": "string",
"description": "This will always be BILLABLEEXPENSE. More types may be added in future."
},
"Status": {
"enum": [
"APPROVED",
"DRAFT",
"ONDRAFT",
"BILLED",
"VOIDED"
],
"type": "string",
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED."
},
"ContactID": {
"type": "string",
"format": "uuid",
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED."
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "The last modified date in UTC format",
"x-is-msdate-time": true
},
"SourceLineItemID": {
"type": "string",
"format": "uuid",
"description": "The line item identifier from the source transaction."
},
"TargetLineItemID": {
"type": "string",
"format": "uuid",
"description": "The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID."
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"LinkedTransactionID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"SourceTransactionID": {
"type": "string",
"format": "uuid",
"description": "Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice"
},
"TargetTransactionID": {
"type": "string",
"format": "uuid",
"description": "Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice"
},
"SourceTransactionTypeCode": {
"enum": [
"ACCPAY",
"SPEND"
],
"type": "string",
"description": "The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction."
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/linked-transactions/"
}
}
LinkedTransactions
{
"type": "object",
"properties": {
"LinkedTransactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedTransaction"
}
}
},
"x-isObjectArray": true
}
ManualJournal
{
"type": "object",
"required": [
"Narration"
],
"properties": {
"Url": {
"type": "string",
"description": "Url link to a source document – shown as “Go to [appName]” in the Xero app"
},
"Date": {
"type": "string",
"description": "Date journal was posted – YYYY-MM-DD",
"x-is-msdate": true
},
"Status": {
"enum": [
"DRAFT",
"POSTED",
"DELETED",
"VOIDED",
"ARCHIVED"
],
"type": "string",
"description": "See Manual Journal Status Codes"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of warning messages from the API"
},
"Narration": {
"type": "string",
"description": "Description of journal being posted"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "Displays array of attachments from the API"
},
"JournalLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualJournalLine"
},
"description": "See JournalLines"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "Boolean to indicate if a manual journal has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Last modified date UTC format",
"x-is-msdate-time": true
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"ManualJournalID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for a Manual Journal"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"StatusAttributeString": {
"type": "string",
"example": "ERROR",
"description": "A string to indicate if a invoice status"
},
"ShowOnCashBasisReports": {
"type": "boolean",
"description": "Boolean – default is true if not specified"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/manual-journals/"
}
}
ManualJournalLine
{
"type": "object",
"properties": {
"IsBlank": {
"type": "boolean",
"example": false,
"description": "is the line blank"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"Tracking": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingCategory"
},
"description": "Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements."
},
"AccountID": {
"type": "string",
"format": "uuid",
"description": "See Accounts"
},
"TaxAmount": {
"type": "number",
"format": "double",
"example": 0,
"x-is-money": true,
"description": "The calculated tax amount based on the TaxType and LineAmount"
},
"LineAmount": {
"type": "number",
"format": "double",
"example": -2569,
"x-is-money": true,
"description": "total for line. Debits are positive, credits are negative value"
},
"AccountCode": {
"type": "string",
"example": 720,
"description": "See Accounts"
},
"Description": {
"type": "string",
"example": "Coded incorrectly Office Equipment should be Computer Equipment",
"description": "Description for journal line"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/manual-journals/"
}
}
ManualJournals
{
"type": "object",
"properties": {
"ManualJournals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualJournal"
}
}
},
"x-isObjectArray": true
}
OnlineInvoice
{
"type": "object",
"properties": {
"OnlineInvoiceUrl": {
"type": "string",
"description": "the URL to an online invoice"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/invoices/"
}
}
OnlineInvoices
{
"type": "object",
"properties": {
"OnlineInvoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnlineInvoice"
}
}
},
"x-isObjectArray": true
}
Organisation
{
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Display name of organisation shown in Xero"
},
"Class": {
"enum": [
"DEMO",
"TRIAL",
"STARTER",
"STANDARD",
"PREMIUM",
"PREMIUM_20",
"PREMIUM_50",
"PREMIUM_100",
"LEDGER",
"GST_CASHBOOK",
"NON_GST_CASHBOOK",
"ULTIMATE",
"LITE"
],
"type": "string",
"description": "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)"
},
"APIKey": {
"type": "string",
"description": "Display a unique key used for Xero-to-Xero transactions"
},
"Phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phone"
},
"description": "Phones details for organisation – see Phones"
},
"Edition": {
"enum": [
"BUSINESS",
"PARTNER"
],
"type": "string",
"description": "BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)"
},
"PaysTax": {
"type": "boolean",
"description": "Boolean to describe if organisation is registered with a local tax authority i.e. true, false"
},
"Version": {
"enum": [
"AU",
"NZ",
"GLOBAL",
"UK",
"US",
"AUONRAMP",
"NZONRAMP",
"GLOBALONRAMP",
"UKONRAMP",
"USONRAMP"
],
"type": "string",
"description": "See Version Types"
},
"Timezone": {
"$ref": "#/components/schemas/TimeZone",
"type": "string"
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressForOrganisation"
},
"description": "Address details for organisation – see Addresses"
},
"LegalName": {
"type": "string",
"description": "Organisation name shown on Reports"
},
"ShortCode": {
"type": "string",
"description": "A unique identifier for the organisation. Potential uses."
},
"TaxNumber": {
"type": "string",
"description": "Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global)."
},
"CountryCode": {
"$ref": "#/components/schemas/CountryCode",
"type": "string"
},
"BaseCurrency": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"PaymentTerms": {
"$ref": "#/components/schemas/PaymentTerm"
},
"ExternalLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalLink"
},
"description": "Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below"
},
"IsDemoCompany": {
"type": "boolean",
"description": "Boolean to describe if organisation is a demo company."
},
"SalesTaxBasis": {
"enum": [
"PAYMENTS",
"INVOICE",
"NONE",
"CASH",
"ACCRUAL",
"FLATRATECASH",
"FLATRATEACCRUAL",
"ACCRUALS"
],
"type": "string",
"description": "The accounting basis used for tax returns. See Sales Tax Basis"
},
"CreatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Timestamp when the organisation was created in Xero",
"x-is-msdate-time": true
},
"LineOfBusiness": {
"type": "string",
"description": "Description of business type as defined in Organisation settings"
},
"OrganisationID": {
"type": "string",
"format": "uuid",
"example": "8be9db36-3598-4755-ba5c-c2dbc8c4a7a2",
"description": "Unique Xero identifier"
},
"PeriodLockDate": {
"type": "string",
"description": "Shown if set. See lock dates",
"x-is-msdate": true
},
"SalesTaxPeriod": {
"enum": [
"MONTHLY",
"QUARTERLY1",
"QUARTERLY2",
"QUARTERLY3",
"ANNUALLY",
"ONEMONTHS",
"TWOMONTHS",
"SIXMONTHS",
"1MONTHLY",
"2MONTHLY",
"3MONTHLY",
"6MONTHLY",
"QUARTERLY",
"YEARLY",
"NONE"
],
"type": "string",
"description": "The frequency with which tax returns are processed. See Sales Tax Period"
},
"DefaultSalesTax": {
"type": "string",
"description": "The default for LineAmountTypes on sales transactions"
},
"OrganisationType": {
"enum": [
"ACCOUNTING_PRACTICE",
"COMPANY",
"CHARITY",
"CLUB_OR_SOCIETY",
"INDIVIDUAL",
"LOOK_THROUGH_COMPANY",
"NOT_FOR_PROFIT",
"PARTNERSHIP",
"S_CORPORATION",
"SELF_MANAGED_SUPERANNUATION_FUND",
"SOLE_TRADER",
"SUPERANNUATION_FUND",
"TRUST"
],
"type": "string",
"description": "Organisation Type"
},
"EndOfYearLockDate": {
"type": "string",
"description": "Shown if set. See lock dates",
"x-is-msdate": true
},
"OrganisationStatus": {
"type": "string",
"description": "Will be set to ACTIVE if you can connect to organisation via the Xero API"
},
"RegistrationNumber": {
"type": "string",
"description": "Shows for New Zealand, Australian and UK organisations"
},
"DefaultPurchasesTax": {
"type": "string",
"description": "The default for LineAmountTypes on purchase transactions"
},
"FinancialYearEndDay": {
"type": "integer",
"description": "Calendar day e.g. 0-31"
},
"FinancialYearEndMonth": {
"type": "integer",
"description": "Calendar Month e.g. 1-12"
},
"OrganisationEntityType": {
"enum": [
"ACCOUNTING_PRACTICE",
"COMPANY",
"CHARITY",
"CLUB_OR_SOCIETY",
"INDIVIDUAL",
"LOOK_THROUGH_COMPANY",
"NOT_FOR_PROFIT",
"PARTNERSHIP",
"S_CORPORATION",
"SELF_MANAGED_SUPERANNUATION_FUND",
"SOLE_TRADER",
"SUPERANNUATION_FUND",
"TRUST"
],
"type": "string",
"description": "Organisation Entity Type"
},
"EmployerIdentificationNumber": {
"type": "string",
"description": "Shown if set. US Only."
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/organisation/"
}
}
Organisations
{
"type": "object",
"properties": {
"Organisations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organisation"
}
}
},
"x-isObjectArray": true
}
Overpayment
{
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "The date the overpayment is created YYYY-MM-DD",
"x-is-msdate": true
},
"Type": {
"enum": [
"RECEIVE-OVERPAYMENT",
"SPEND-OVERPAYMENT",
"AROVERPAYMENT"
],
"type": "string",
"description": "See Overpayment Types"
},
"Total": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The total of the overpayment (subtotal + total tax)"
},
"Status": {
"enum": [
"AUTHORISED",
"PAID",
"VOIDED"
],
"type": "string",
"description": "See Overpayment Status Codes"
},
"Contact": {
"$ref": "#/components/schemas/Contact"
},
"Payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
},
"description": "See Payments"
},
"SubTotal": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The subtotal of the overpayment excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The total tax on the overpayment"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
},
"description": "See Overpayment Line Items"
},
"Allocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Allocation"
},
"description": "See Allocations"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "See Attachments"
},
"CurrencyCode": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used"
},
"AppliedAmount": {
"type": "number",
"format": "double",
"example": 2,
"description": "The amount of applied to an invoice"
},
"OverpaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "boolean to indicate if a overpayment has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "UTC timestamp of last update to the overpayment",
"x-is-msdate-time": true
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"RemainingCredit": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The remaining credit balance on the overpayment"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/overpayments/"
}
}
Overpayments
{
"type": "object",
"properties": {
"Overpayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Overpayment"
}
}
},
"x-isObjectArray": true
}
Payment
{
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": "Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06",
"x-is-msdate": true
},
"Amount": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00"
},
"Status": {
"enum": [
"AUTHORISED",
"DELETED"
],
"type": "string",
"description": "The status of the payment."
},
"Account": {
"$ref": "#/components/schemas/Account"
},
"Details": {
"type": "string",
"description": "The information to appear on the supplier's bank account"
},
"Invoice": {
"$ref": "#/components/schemas/Invoice"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of warning messages from the API"
},
"PaymentID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"Reference": {
"type": "string",
"description": "An optional description for the payment e.g. Direct Debit"
},
"BankAmount": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The amount of the payment in the currency of the bank account."
},
"CreditNote": {
"$ref": "#/components/schemas/CreditNote"
},
"HasAccount": {
"type": "boolean",
"default": "false",
"example": false,
"description": "A boolean to indicate if a contact has an validation errors"
},
"Prepayment": {
"$ref": "#/components/schemas/Prepayment"
},
"Overpayment": {
"$ref": "#/components/schemas/Overpayment"
},
"Particulars": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"PaymentType": {
"enum": [
"ACCRECPAYMENT",
"ACCPAYPAYMENT",
"ARCREDITPAYMENT",
"APCREDITPAYMENT",
"AROVERPAYMENTPAYMENT",
"ARPREPAYMENTPAYMENT",
"APPREPAYMENTPAYMENT",
"APOVERPAYMENTPAYMENT"
],
"type": "string",
"readOnly": true,
"description": "See Payment Types."
},
"BatchPayment": {
"$ref": "#/components/schemas/BatchPayment"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500"
},
"IsReconciled": {
"type": "boolean",
"description": "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"
},
"InvoiceNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g.INV-4003"
},
"BatchPaymentID": {
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"description": "Present if the payment was created as part of a batch."
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "UTC timestamp of last update to the payment",
"x-is-msdate-time": true
},
"CreditNoteNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g. INV-4003"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"BankAccountNumber": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"HasValidationErrors": {
"type": "boolean",
"default": "false",
"example": false,
"description": "A boolean to indicate if a contact has an validation errors"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/payments/"
}
}
PaymentDelete
{
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"type": "string",
"default": "DELETED",
"description": "The status of the payment."
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/payments/"
}
}
PaymentService
{
"properties": {
"PayNowText": {
"type": "string",
"description": "The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card"
},
"PaymentServiceID": {
"type": "string",
"format": "uuid",
"description": "Xero identifier"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"PaymentServiceUrl": {
"type": "string",
"description": "The custom payment URL"
},
"PaymentServiceName": {
"type": "string",
"description": "Name of payment service"
},
"PaymentServiceType": {
"type": "string",
"description": "This will always be CUSTOM for payment services created via the API."
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/branding-themes/"
}
}
PaymentServices
{
"type": "object",
"properties": {
"PaymentServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentService"
}
}
},
"x-isObjectArray": true
}
PaymentTerm
{
"type": "object",
"properties": {
"Bills": {
"$ref": "#/components/schemas/Bill"
},
"Sales": {
"$ref": "#/components/schemas/Bill"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/organisation/"
}
}
PaymentTermType
{
"enum": [
"DAYSAFTERBILLDATE",
"DAYSAFTERBILLMONTH",
"OFCURRENTMONTH",
"OFFOLLOWINGMONTH"
],
"type": "string"
}
Payments
{
"type": "object",
"properties": {
"Payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
},
"x-isObjectArray": true
}
Phone
{
"type": "object",
"properties": {
"PhoneType": {
"enum": [
"DEFAULT",
"DDI",
"MOBILE",
"FAX",
"OFFICE"
],
"type": "string"
},
"PhoneNumber": {
"type": "string",
"maxLength": 50,
"description": "max length = 50"
},
"PhoneAreaCode": {
"type": "string",
"maxLength": 10,
"description": "max length = 10"
},
"PhoneCountryCode": {
"type": "string",
"maxLength": 20,
"description": "max length = 20"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/types"
}
}
Prepayment
{
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "The date the prepayment is created YYYY-MM-DD",
"x-is-msdate": true
},
"Type": {
"enum": [
"RECEIVE-PREPAYMENT",
"SPEND-PREPAYMENT",
"ARPREPAYMENT",
"APPREPAYMENT"
],
"type": "string",
"description": "See Prepayment Types"
},
"Total": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The total of the prepayment(subtotal + total tax)"
},
"Status": {
"enum": [
"AUTHORISED",
"PAID",
"VOIDED"
],
"type": "string",
"description": "See Prepayment Status Codes"
},
"Contact": {
"$ref": "#/components/schemas/Contact"
},
"Payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
},
"description": "See Payments"
},
"SubTotal": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The subtotal of the prepayment excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The total tax on the prepayment"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
},
"description": "See Prepayment Line Items"
},
"Reference": {
"type": "string",
"readOnly": true,
"description": "Returns Invoice number field. Reference field isn't available."
},
"Allocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Allocation"
},
"description": "See Allocations"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "See Attachments"
},
"CurrencyCode": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used"
},
"PrepaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier"
},
"AppliedAmount": {
"type": "number",
"format": "double",
"example": 2,
"description": "The amount of applied to an invoice"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "boolean to indicate if a prepayment has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "UTC timestamp of last update to the prepayment",
"x-is-msdate-time": true
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"RemainingCredit": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The remaining credit balance on the prepayment"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/prepayments/"
}
}
Prepayments
{
"type": "object",
"properties": {
"Prepayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prepayment"
}
}
},
"x-isObjectArray": true
}
Purchase
{
"type": "object",
"properties": {
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"UnitPrice": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request."
},
"AccountCode": {
"type": "string",
"description": "Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items"
},
"COGSAccountCode": {
"type": "string",
"description": "Cost of goods sold account. Only applicable to the purchase details of tracked items."
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/items/"
}
}
PurchaseOrder
{
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation",
"x-is-msdate": true
},
"Total": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)"
},
"Status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"BILLED",
"DELETED"
],
"type": "string",
"description": "See Purchase Order Status Codes"
},
"Contact": {
"$ref": "#/components/schemas/Contact"
},
"SubTotal": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of purchase order excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total tax on purchase order"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of warning messages from the API"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
},
"description": "See LineItems"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"Telephone": {
"type": "string",
"description": "The phone number for the person accepting the delivery"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "Displays array of attachments from the API"
},
"AttentionTo": {
"type": "string",
"description": "The person that the delivery is going to"
},
"CurrencyCode": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used."
},
"DeliveryDate": {
"type": "string",
"description": "Date the goods are to be delivered – YYYY-MM-DD",
"x-is-msdate": true
},
"SentToContact": {
"type": "boolean",
"description": "Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed"
},
"TotalDiscount": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of discounts applied on the purchase order line items"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "boolean to indicate if a purchase order has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Last modified date UTC format",
"x-is-msdate-time": true
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"DeliveryAddress": {
"type": "string",
"description": "The address the goods are to be delivered to"
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"PurchaseOrderID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for purchase order"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"ExpectedArrivalDate": {
"type": "string",
"description": "The date the goods are expected to arrive.",
"x-is-msdate": true
},
"PurchaseOrderNumber": {
"type": "string",
"description": "Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)"
},
"DeliveryInstructions": {
"type": "string",
"description": "A free text feild for instructions (500 characters max)"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/purchase-orders/"
}
}
PurchaseOrders
{
"type": "object",
"properties": {
"PurchaseOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrder"
}
}
},
"x-isObjectArray": true
}
Quote
{
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation",
"x-is-msdate": true
},
"Terms": {
"type": "string",
"maxLength": 4000,
"description": "Terms of the quote"
},
"Title": {
"type": "string",
"maxLength": 100,
"description": "Title text for the quote"
},
"Total": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts"
},
"Status": {
"$ref": "#/components/schemas/QuoteStatusCodes",
"type": "string"
},
"Contact": {
"$ref": "#/components/schemas/Contact",
"type": "string"
},
"QuoteID": {
"type": "string",
"format": "uuid",
"description": "QuoteID GUID is automatically generated and is returned after create or GET."
},
"Summary": {
"type": "string",
"maxLength": 3000,
"description": "Summary text for the quote"
},
"SubTotal": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of quote excluding taxes."
},
"TotalTax": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total tax on quote"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
},
"description": "See LineItems"
},
"Reference": {
"type": "string",
"maxLength": 4000,
"description": "Additional reference number"
},
"DateString": {
"type": "string",
"description": "Date the quote was issued (YYYY-MM-DD)"
},
"ExpiryDate": {
"type": "string",
"description": "Date the quote expires – YYYY-MM-DD.",
"x-is-msdate": true
},
"QuoteNumber": {
"type": "string",
"maxLength": 255,
"description": "Unique alpha numeric code identifying a quote (Max Length = 255)"
},
"CurrencyCode": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"description": "The currency rate for a multicurrency quote"
},
"TotalDiscount": {
"type": "number",
"format": "double",
"readOnly": true,
"x-is-money": true,
"description": "Total of discounts applied on the quote line items"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Last modified date UTC format",
"x-is-msdate-time": true
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"LineAmountTypes": {
"$ref": "#/components/schemas/QuoteLineAmountTypes",
"type": "string",
"description": "See Quote Line Amount Types"
},
"ExpiryDateString": {
"type": "string",
"description": "Date the quote expires – YYYY-MM-DD."
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/Quotes/"
}
}
QuoteLineAmountTypes
{
"enum": [
"EXCLUSIVE",
"INCLUSIVE",
"NOTAX"
],
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
}
QuoteStatusCodes
{
"enum": [
"DRAFT",
"SENT",
"DECLINED",
"ACCEPTED",
"INVOICED",
"DELETED"
],
"type": "string",
"description": "The status of the quote."
}
Quotes
{
"type": "object",
"properties": {
"Quotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Quote"
}
}
},
"x-isObjectArray": true
}
Receipt
{
"type": "object",
"properties": {
"Url": {
"type": "string",
"readOnly": true,
"description": "URL link to a source document – shown as “Go to [appName]” in the Xero app"
},
"Date": {
"type": "string",
"description": "Date of receipt – YYYY-MM-DD",
"x-is-msdate": true
},
"User": {
"$ref": "#/components/schemas/User"
},
"Total": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total of receipt tax inclusive (i.e. SubTotal + TotalTax)"
},
"Status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"DECLINED",
"VOIDED"
],
"type": "string",
"description": "Current status of receipt – see status types"
},
"Contact": {
"$ref": "#/components/schemas/Contact"
},
"SubTotal": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total of receipt excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total tax on receipt"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of warning messages from the API"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"ReceiptID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for receipt"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "Displays array of attachments from the API"
},
"ReceiptNumber": {
"type": "string",
"readOnly": true,
"description": "Xero generated sequence number for receipt in current claim for a given user"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "boolean to indicate if a receipt has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Last modified date UTC format",
"x-is-msdate-time": true
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"ValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Displays array of validation error messages from the API"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/receipts/"
}
}
Receipts
{
"type": "object",
"properties": {
"Receipts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt"
}
}
},
"x-isObjectArray": true
}
RepeatingInvoice
{
"type": "object",
"properties": {
"ID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for repeating invoice template"
},
"Type": {
"enum": [
"ACCPAY",
"ACCREC"
],
"type": "string",
"description": "See Invoice Types"
},
"Total": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)"
},
"Status": {
"enum": [
"DRAFT",
"AUTHORISED",
"DELETED"
],
"type": "string",
"description": "One of the following - DRAFT or AUTHORISED – See Invoice Status Codes"
},
"Contact": {
"$ref": "#/components/schemas/Contact"
},
"Schedule": {
"$ref": "#/components/schemas/Schedule"
},
"SendCopy": {
"type": "boolean",
"default": "false",
"example": false,
"description": "Boolean to indicate whether a copy is sent to sender's email"
},
"SubTotal": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total of invoice excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"x-is-money": true,
"description": "Total tax on invoice"
},
"LineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
},
"description": "See LineItems"
},
"Reference": {
"type": "string",
"description": "ACCREC only – additional reference number"
},
"IncludePDF": {
"type": "boolean",
"default": "false",
"example": false,
"description": "Boolean to indicate whether to include PDF attachment"
},
"MarkAsSent": {
"type": "boolean",
"default": "false",
"example": false,
"description": "Boolean to indicate whether the invoice in the Xero app displays as \"sent\""
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
},
"description": "Displays array of attachments from the API"
},
"CurrencyCode": {
"$ref": "#/components/schemas/CurrencyCode",
"type": "string"
},
"HasAttachments": {
"type": "boolean",
"default": "false",
"example": false,
"readOnly": true,
"description": "Boolean to indicate if an invoice has an attachment"
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"LineAmountTypes": {
"$ref": "#/components/schemas/LineAmountTypes",
"type": "string"
},
"ApprovedForSending": {
"type": "boolean",
"default": "false",
"example": false,
"description": "Boolean to indicate whether the invoice has been approved for sending"
},
"RepeatingInvoiceID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for repeating invoice template"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/repeating-invoices/"
}
}
RepeatingInvoices
{
"type": "object",
"properties": {
"RepeatingInvoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepeatingInvoice"
}
}
},
"x-isObjectArray": true
}
Report
{
"properties": {
"Contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenNinetyNineContact"
}
},
"ReportDate": {
"type": "string",
"description": "Date of report"
},
"ReportName": {
"type": "string",
"description": "See Prepayment Types"
},
"ReportType": {
"enum": [
"AgedPayablesByContact"
],
"type": "string",
"description": "See Prepayment Types"
},
"ReportTitle": {
"type": "string",
"description": "See Prepayment Types"
},
"UpdatedDateUTC": {
"type": "string",
"example": "/Date(1573755038314)/",
"readOnly": true,
"description": "Updated Date",
"x-is-msdate-time": true
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/reports/"
}
}
ReportAttribute
{
"properties": {
"Id": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"externalDocs": {
"url": "http://developer.xero.com/documentation/api/reports/"
}
}
ReportCell
{
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"Attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportAttribute"
}
}
}
}
ReportFields
{
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"FieldID": {
"type": "string"
},
"Description": {
"type": "string"
}
}
}
ReportRow
{
"type": "object",
"properties": {
"Cells": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportCell"
}
},
"Title": {
"type": "string"
},
"RowType": {
"$ref": "#/components/schemas/RowType"
}
}
}
ReportRows
{
"type": "object",
"properties": {
"Rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportRow"
}
},
"Cells": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportCell"
}
},
"Title": {
"type": "string"
},
"RowType": {
"$ref": "#/components/schemas/RowType"
}
}
}