> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # xero-invoicing > Xero Invoicing — manage invoices, credit notes, quotes, and repeating invoices **Server path:** `/xero-invoicing` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | [`xero_invoicing_create_credit_note_allocation`](#xero_invoicing_create_credit_note_allocation) | Creates allocation for a specific credit note | | [`xero_invoicing_create_credit_notes`](#xero_invoicing_create_credit_notes) | Creates a new credit note | | [`xero_invoicing_create_invoices`](#xero_invoicing_create_invoices) | Creates one or more sales invoices or purchase bills | | [`xero_invoicing_create_quotes`](#xero_invoicing_create_quotes) | Create one or more quotes | | [`xero_invoicing_create_repeating_invoices`](#xero_invoicing_create_repeating_invoices) | Creates one or more repeating invoice templates | | [`xero_invoicing_delete_credit_note_allocations`](#xero_invoicing_delete_credit_note_allocations) | Deletes an Allocation from a Credit Note | | [`xero_invoicing_email_invoice`](#xero_invoicing_email_invoice) | Sends a copy of a specific invoice to related contact via email | | [`xero_invoicing_get_credit_note`](#xero_invoicing_get_credit_note) | Retrieves a specific credit note using a unique credit note Id | | [`xero_invoicing_get_credit_note_as_pdf`](#xero_invoicing_get_credit_note_as_pdf) | Retrieves credit notes as PDF files | | [`xero_invoicing_get_credit_notes`](#xero_invoicing_get_credit_notes) | Retrieves any credit notes | | [`xero_invoicing_get_invoice`](#xero_invoicing_get_invoice) | Retrieves a specific sales invoice or purchase bill using a unique invoice Id | | [`xero_invoicing_get_invoice_as_pdf`](#xero_invoicing_get_invoice_as_pdf) | Retrieves invoices or purchase bills as PDF files | | [`xero_invoicing_get_invoices`](#xero_invoicing_get_invoices) | Retrieves sales invoices or purchase bills | | [`xero_invoicing_get_online_invoice`](#xero_invoicing_get_online_invoice) | Retrieves a URL to an online invoice | | [`xero_invoicing_get_quote`](#xero_invoicing_get_quote) | Retrieves a specific quote using a unique quote Id | | [`xero_invoicing_get_quote_as_pdf`](#xero_invoicing_get_quote_as_pdf) | Retrieves a specific quote as a PDF file using a unique quote Id | | [`xero_invoicing_get_quotes`](#xero_invoicing_get_quotes) | Retrieves sales quotes | | [`xero_invoicing_get_repeating_invoice`](#xero_invoicing_get_repeating_invoice) | Retrieves a specific repeating invoice by using a unique repeating invoice Id | | [`xero_invoicing_get_repeating_invoices`](#xero_invoicing_get_repeating_invoices) | Retrieves repeating invoices | | [`xero_invoicing_update_credit_note`](#xero_invoicing_update_credit_note) | Updates a specific credit note | | [`xero_invoicing_update_invoice`](#xero_invoicing_update_invoice) | Updates a specific sales invoices or purchase bills | | [`xero_invoicing_update_or_create_credit_notes`](#xero_invoicing_update_or_create_credit_notes) | Updates or creates one or more credit notes | | [`xero_invoicing_update_or_create_invoices`](#xero_invoicing_update_or_create_invoices) | Updates or creates one or more sales invoices or purchase bills | | [`xero_invoicing_update_or_create_quotes`](#xero_invoicing_update_or_create_quotes) | Updates or creates one or more quotes | | [`xero_invoicing_update_or_create_repeating_invoices`](#xero_invoicing_update_or_create_repeating_invoices) | Creates or deletes one or more repeating invoice templates | | [`xero_invoicing_update_quote`](#xero_invoicing_update_quote) | Updates a specific quote | | [`xero_invoicing_update_repeating_invoice`](#xero_invoicing_update_repeating_invoice) | Deletes a specific repeating invoice template | *** ## xero\_invoicing\_create\_credit\_note\_allocation Creates allocation for a specific credit note **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `CreditNoteID` | string | Yes | — | Unique identifier for a Credit Note | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Allocations` | object\[] | No | — | The allocations value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "CreditNoteID": { "type": "string", "description": "Unique identifier for a Credit Note" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Allocations": { "type": "array", "items": { "type": "object", "properties": { "AllocationID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier" }, "Invoice": { "type": "object", "description": "The invoice value" }, "Overpayment": { "type": "object", "description": "The overpayment value" }, "Prepayment": { "type": "object", "description": "The prepayment value" }, "CreditNote": { "type": "object", "description": "Credit Note" }, "Amount": { "type": "number", "format": "double", "description": "the amount being applied to the invoice" }, "Date": { "type": "string", "description": "the date the allocation is applied YYYY-MM-DD." }, "IsDeleted": { "type": "boolean", "description": "A flag that returns true when the allocation is succesfully deleted" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" } }, "required": [ "Amount", "Invoice", "Date" ] }, "description": "The allocations value" } }, "required": [ "PCID", "xero-tenant-id", "CreditNoteID" ] } ``` *** ## xero\_invoicing\_create\_credit\_notes Creates a new credit note **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `CreditNotes` | object\[] | No | — | Credit Notes | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAYCREDIT", "ACCRECCREDIT" ], "description": "See Credit Note Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "format": "double", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "The total tax on the credit note" }, "Total": { "type": "number", "format": "double", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "format": "double", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "items": { "type": "object", "properties": { "AllocationID": { "type": "string", "description": "Xero generated unique identifier" }, "Invoice": { "type": "object" }, "Overpayment": { "type": "object" }, "Prepayment": { "type": "object" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Amount": { "type": "number", "description": "the amount being applied to the invoice" }, "Date": { "type": "string", "description": "the date the allocation is applied YYYY-MM-DD." }, "IsDeleted": { "type": "boolean", "description": "A flag that returns true when the allocation is succesfully deleted" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" } } }, "description": "See Allocations" }, "AppliedAmount": { "type": "number", "format": "double", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Credit Notes" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_create\_invoices Creates one or more sales invoices or purchase bills **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Invoices` | object\[] | No | — | The invoices value | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Invoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "InvoiceNumber": { "type": "string", "description": "ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "Url": { "type": "string", "description": "URL link to a source document – shown as “Go to [appName]” in the Xero app" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Invoice Status Codes" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "string", "description": "Shown on sales invoices (Accounts Receivable) when this has been set" }, "PlannedPaymentDate": { "type": "string", "description": "Shown on bills (Accounts Payable) when this has been set" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the invoice line items" }, "InvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for invoice" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoices" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if an invoice has an attachment" }, "IsDiscounted": { "type": "boolean", "description": "boolean to indicate if an invoice has a discount" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "Prepayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Prepayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the prepayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Prepayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Prepayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the prepayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the prepayment" }, "Total": { "type": "number", "description": "The total of the prepayment(subtotal + total tax)" }, "Reference": { "type": "string", "description": "Returns Invoice number field. Reference field isn't available." }, "InvoiceNumber": { "type": "string", "description": "Returns Invoice number for prepayment receive document only." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the prepayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "PrepaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "BrandingThemeID": { "type": "string", "description": "The unique identifier of the branding template applied to a receive prepayment" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the prepayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "Payments": { "type": "array", "description": "See Payments" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a prepayment has an attachment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Prepayments" }, "Overpayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Overpayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the overpayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Overpayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Overpayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the overpayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the overpayment" }, "Total": { "type": "number", "description": "The total of the overpayment (subtotal + total tax)" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the overpayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "OverpaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the overpayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a overpayment has an attachment" }, "Reference": { "type": "string", "description": "An optional description for Overpayment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Overpayments" }, "AmountDue": { "type": "number", "format": "double", "description": "Amount remaining to be paid on invoice" }, "AmountPaid": { "type": "number", "format": "double", "description": "Sum of payments received for invoice" }, "FullyPaidOnDate": { "type": "string", "description": "The date the invoice was fully paid. Only returned on fully paid invoices" }, "AmountCredited": { "type": "number", "format": "double", "description": "Sum of all credit notes, over-payments and pre-payments applied to invoice" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Credit Note Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the credit note" }, "Total": { "type": "number", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "BrandingThemeID": { "type": "string", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Details of credit notes that have been applied to an invoice" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a invoice has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "The invoices value" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_create\_quotes Create one or more quotes **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Quotes` | object\[] | No | — | The quotes value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Quotes": { "type": "array", "items": { "type": "object", "properties": { "QuoteID": { "type": "string", "format": "uuid", "description": "QuoteID GUID is automatically generated and is returned after create or GET." }, "QuoteNumber": { "type": "string", "description": "Unique alpha numeric code identifying a quote (Max Length = 255)" }, "Reference": { "type": "string", "description": "Additional reference number" }, "Terms": { "type": "string", "description": "Terms of the quote" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "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" }, "DateString": { "type": "string", "description": "Date the quote was issued (YYYY-MM-DD)" }, "ExpiryDate": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "ExpiryDateString": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "Status": { "type": "string", "enum": [ "DRAFT", "SENT", "DECLINED", "ACCEPTED", "INVOICED", "DELETED" ], "description": "The status of the quote." }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency quote" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of quote excluding taxes." }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on quote" }, "Total": { "type": "number", "format": "double", "description": "Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the quote line items" }, "Title": { "type": "string", "description": "Title text for the quote" }, "Summary": { "type": "string", "description": "Summary text for the quote" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "LineAmountTypes": { "type": "string", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" } } }, "description": "The quotes value" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_create\_repeating\_invoices Creates one or more repeating invoice templates **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `RepeatingInvoices` | object\[] | No | — | Repeating Invoices | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "RepeatingInvoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCREC" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Schedule": { "type": "object", "description": "The schedule value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "Status": { "type": "string", "enum": [ "DRAFT", "AUTHORISED", "DELETED" ], "description": "One of the following - DRAFT or AUTHORISED – See Invoice Status Codes" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "ID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "HasAttachments": { "type": "boolean", "description": "Boolean to indicate if an invoice has an attachment" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "ApprovedForSending": { "type": "boolean", "description": "Boolean to indicate whether the invoice has been approved for sending" }, "SendCopy": { "type": "boolean", "description": "Boolean to indicate whether a copy is sent to sender's email" }, "MarkAsSent": { "type": "boolean", "description": "Boolean to indicate whether the invoice in the Xero app displays as \"sent\"" }, "IncludePDF": { "type": "boolean", "description": "Boolean to indicate whether to include PDF attachment" } } }, "description": "Repeating Invoices" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_delete\_credit\_note\_allocations Deletes an Allocation from a Credit Note **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `CreditNoteID` | string | Yes | — | Unique identifier for a Credit Note | | `AllocationID` | string | Yes | — | Unique identifier for Allocation object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "CreditNoteID": { "type": "string", "description": "Unique identifier for a Credit Note" }, "AllocationID": { "type": "string", "description": "Unique identifier for Allocation object" } }, "required": [ "PCID", "xero-tenant-id", "CreditNoteID", "AllocationID" ] } ``` *** ## xero\_invoicing\_email\_invoice Sends a copy of a specific invoice to related contact via email **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `InvoiceID` | string | Yes | — | Unique identifier for an Invoice | | `Status` | string | No | — | Need at least one field to create an empty JSON payload | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "InvoiceID": { "type": "string", "description": "Unique identifier for an Invoice" }, "Status": { "type": "string", "description": "Need at least one field to create an empty JSON payload" } }, "required": [ "PCID", "xero-tenant-id", "InvoiceID" ] } ``` *** ## xero\_invoicing\_get\_credit\_note Retrieves a specific credit note using a unique credit note Id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `CreditNoteID` | string | Yes | — | Unique identifier for a Credit Note | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "CreditNoteID": { "type": "string", "description": "Unique identifier for a Credit Note" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } }, "required": [ "PCID", "xero-tenant-id", "CreditNoteID" ] } ``` *** ## xero\_invoicing\_get\_credit\_note\_as\_pdf Retrieves credit notes as PDF files **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `CreditNoteID` | string | Yes | — | Unique identifier for a Credit Note | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "CreditNoteID": { "type": "string", "description": "Unique identifier for a Credit Note" } }, "required": [ "PCID", "xero-tenant-id", "CreditNoteID" ] } ``` *** ## xero\_invoicing\_get\_credit\_notes Retrieves any credit notes **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `If-Modified-Since` | string | No | — | Only records created or modified since this timestamp will be returned | | `where` | string | No | — | Filter by an any element | | `order` | string | No | — | Order by an any element | | `page` | integer | No | — | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `pageSize` | integer | No | — | Number of records to retrieve per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "If-Modified-Since": { "type": "string", "description": "Only records created or modified since this timestamp will be returned" }, "where": { "type": "string", "description": "Filter by an any element" }, "order": { "type": "string", "description": "Order by an any element" }, "page": { "type": "integer", "description": "e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "pageSize": { "type": "integer", "description": "Number of records to retrieve per page" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_get\_invoice Retrieves a specific sales invoice or purchase bill using a unique invoice Id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `InvoiceID` | string | Yes | — | Unique identifier for an Invoice | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "InvoiceID": { "type": "string", "description": "Unique identifier for an Invoice" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" } }, "required": [ "PCID", "xero-tenant-id", "InvoiceID" ] } ``` *** ## xero\_invoicing\_get\_invoice\_as\_pdf Retrieves invoices or purchase bills as PDF files **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `InvoiceID` | string | Yes | — | Unique identifier for an Invoice | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "InvoiceID": { "type": "string", "description": "Unique identifier for an Invoice" } }, "required": [ "PCID", "xero-tenant-id", "InvoiceID" ] } ``` *** ## xero\_invoicing\_get\_invoices Retrieves sales invoices or purchase bills **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `If-Modified-Since` | string | No | — | Only records created or modified since this timestamp will be returned | | `where` | string | No | — | Filter by an any element | | `order` | string | No | — | Order by an any element | | `IDs` | string\[] | No | — | Filter by a comma-separated list of InvoicesIDs. | | `InvoiceNumbers` | string\[] | No | — | Filter by a comma-separated list of InvoiceNumbers. | | `ContactIDs` | string\[] | No | — | Filter by a comma-separated list of ContactIDs. | | `Statuses` | string\[] | No | — | Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. | | `page` | integer | No | — | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice | | `includeArchived` | boolean | No | — | e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response | | `createdByMyApp` | boolean | No | — | When set to true you'll only retrieve Invoices created by your app | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `summaryOnly` | boolean | No | — | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | | `pageSize` | integer | No | — | Number of records to retrieve per page | | `searchTerm` | string | No | — | Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "If-Modified-Since": { "type": "string", "description": "Only records created or modified since this timestamp will be returned" }, "where": { "type": "string", "description": "Filter by an any element" }, "order": { "type": "string", "description": "Order by an any element" }, "IDs": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by a comma-separated list of InvoicesIDs." }, "InvoiceNumbers": { "type": "array", "items": { "type": "string" }, "description": "Filter by a comma-separated list of InvoiceNumbers." }, "ContactIDs": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by a comma-separated list of ContactIDs." }, "Statuses": { "type": "array", "items": { "type": "string" }, "description": "Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter." }, "page": { "type": "integer", "description": "e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice" }, "includeArchived": { "type": "boolean", "description": "e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response" }, "createdByMyApp": { "type": "boolean", "description": "When set to true you'll only retrieve Invoices created by your app" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "summaryOnly": { "type": "boolean", "description": "Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient." }, "pageSize": { "type": "integer", "description": "Number of records to retrieve per page" }, "searchTerm": { "type": "string", "description": "Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference." } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_get\_online\_invoice Retrieves a URL to an online invoice **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `InvoiceID` | string | Yes | — | Unique identifier for an Invoice | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "InvoiceID": { "type": "string", "description": "Unique identifier for an Invoice" } }, "required": [ "PCID", "xero-tenant-id", "InvoiceID" ] } ``` *** ## xero\_invoicing\_get\_quote Retrieves a specific quote using a unique quote Id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `QuoteID` | string | Yes | — | Unique identifier for an Quote | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "QuoteID": { "type": "string", "description": "Unique identifier for an Quote" } }, "required": [ "PCID", "xero-tenant-id", "QuoteID" ] } ``` *** ## xero\_invoicing\_get\_quote\_as\_pdf Retrieves a specific quote as a PDF file using a unique quote Id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `QuoteID` | string | Yes | — | Unique identifier for an Quote | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "QuoteID": { "type": "string", "description": "Unique identifier for an Quote" } }, "required": [ "PCID", "xero-tenant-id", "QuoteID" ] } ``` *** ## xero\_invoicing\_get\_quotes Retrieves sales quotes **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `If-Modified-Since` | string | No | — | Only records created or modified since this timestamp will be returned | | `DateFrom` | string | No | — | Filter for quotes after a particular date | | `DateTo` | string | No | — | Filter for quotes before a particular date | | `ExpiryDateFrom` | string | No | — | Filter for quotes expiring after a particular date | | `ExpiryDateTo` | string | No | — | Filter for quotes before a particular date | | `ContactID` | string | No | — | Filter for quotes belonging to a particular contact | | `Status` | string | No | — | Filter for quotes of a particular Status | | `page` | integer | No | — | e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote | | `order` | string | No | — | Order by an any element | | `QuoteNumber` | string | No | — | Filter by quote number (e.g. GET [https://.../Quotes?QuoteNumber=QU-0001](https://.../Quotes?QuoteNumber=QU-0001)) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "If-Modified-Since": { "type": "string", "description": "Only records created or modified since this timestamp will be returned" }, "DateFrom": { "type": "string", "description": "Filter for quotes after a particular date" }, "DateTo": { "type": "string", "description": "Filter for quotes before a particular date" }, "ExpiryDateFrom": { "type": "string", "description": "Filter for quotes expiring after a particular date" }, "ExpiryDateTo": { "type": "string", "description": "Filter for quotes before a particular date" }, "ContactID": { "type": "string", "description": "Filter for quotes belonging to a particular contact" }, "Status": { "type": "string", "description": "Filter for quotes of a particular Status" }, "page": { "type": "integer", "description": "e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote" }, "order": { "type": "string", "description": "Order by an any element" }, "QuoteNumber": { "type": "string", "description": "Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_get\_repeating\_invoice Retrieves a specific repeating invoice by using a unique repeating invoice Id **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ----------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `RepeatingInvoiceID` | string | Yes | — | Unique identifier for a Repeating Invoice | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "RepeatingInvoiceID": { "type": "string", "description": "Unique identifier for a Repeating Invoice" } }, "required": [ "PCID", "xero-tenant-id", "RepeatingInvoiceID" ] } ``` *** ## xero\_invoicing\_get\_repeating\_invoices Retrieves repeating invoices **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `where` | string | No | — | Filter by an any element | | `order` | string | No | — | Order by an any element | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "where": { "type": "string", "description": "Filter by an any element" }, "order": { "type": "string", "description": "Order by an any element" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_update\_credit\_note Updates a specific credit note **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `CreditNoteID` | string | Yes | — | Unique identifier for a Credit Note | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `CreditNotes` | object\[] | No | — | Credit Notes | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "CreditNoteID": { "type": "string", "description": "Unique identifier for a Credit Note" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAYCREDIT", "ACCRECCREDIT" ], "description": "See Credit Note Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "format": "double", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "The total tax on the credit note" }, "Total": { "type": "number", "format": "double", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "format": "double", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "items": { "type": "object", "properties": { "AllocationID": { "type": "string", "description": "Xero generated unique identifier" }, "Invoice": { "type": "object" }, "Overpayment": { "type": "object" }, "Prepayment": { "type": "object" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Amount": { "type": "number", "description": "the amount being applied to the invoice" }, "Date": { "type": "string", "description": "the date the allocation is applied YYYY-MM-DD." }, "IsDeleted": { "type": "boolean", "description": "A flag that returns true when the allocation is succesfully deleted" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" } } }, "description": "See Allocations" }, "AppliedAmount": { "type": "number", "format": "double", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Credit Notes" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id", "CreditNoteID" ] } ``` *** ## xero\_invoicing\_update\_invoice Updates a specific sales invoices or purchase bills **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `InvoiceID` | string | Yes | — | Unique identifier for an Invoice | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Invoices` | object\[] | No | — | The invoices value | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "InvoiceID": { "type": "string", "description": "Unique identifier for an Invoice" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Invoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "InvoiceNumber": { "type": "string", "description": "ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "Url": { "type": "string", "description": "URL link to a source document – shown as “Go to [appName]” in the Xero app" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Invoice Status Codes" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "string", "description": "Shown on sales invoices (Accounts Receivable) when this has been set" }, "PlannedPaymentDate": { "type": "string", "description": "Shown on bills (Accounts Payable) when this has been set" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the invoice line items" }, "InvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for invoice" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoices" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if an invoice has an attachment" }, "IsDiscounted": { "type": "boolean", "description": "boolean to indicate if an invoice has a discount" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "Prepayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Prepayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the prepayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Prepayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Prepayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the prepayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the prepayment" }, "Total": { "type": "number", "description": "The total of the prepayment(subtotal + total tax)" }, "Reference": { "type": "string", "description": "Returns Invoice number field. Reference field isn't available." }, "InvoiceNumber": { "type": "string", "description": "Returns Invoice number for prepayment receive document only." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the prepayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "PrepaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "BrandingThemeID": { "type": "string", "description": "The unique identifier of the branding template applied to a receive prepayment" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the prepayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "Payments": { "type": "array", "description": "See Payments" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a prepayment has an attachment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Prepayments" }, "Overpayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Overpayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the overpayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Overpayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Overpayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the overpayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the overpayment" }, "Total": { "type": "number", "description": "The total of the overpayment (subtotal + total tax)" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the overpayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "OverpaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the overpayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a overpayment has an attachment" }, "Reference": { "type": "string", "description": "An optional description for Overpayment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Overpayments" }, "AmountDue": { "type": "number", "format": "double", "description": "Amount remaining to be paid on invoice" }, "AmountPaid": { "type": "number", "format": "double", "description": "Sum of payments received for invoice" }, "FullyPaidOnDate": { "type": "string", "description": "The date the invoice was fully paid. Only returned on fully paid invoices" }, "AmountCredited": { "type": "number", "format": "double", "description": "Sum of all credit notes, over-payments and pre-payments applied to invoice" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Credit Note Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the credit note" }, "Total": { "type": "number", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "BrandingThemeID": { "type": "string", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Details of credit notes that have been applied to an invoice" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a invoice has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "The invoices value" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id", "InvoiceID" ] } ``` *** ## xero\_invoicing\_update\_or\_create\_credit\_notes Updates or creates one or more credit notes **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `CreditNotes` | object\[] | No | — | Credit Notes | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAYCREDIT", "ACCRECCREDIT" ], "description": "See Credit Note Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "format": "double", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "The total tax on the credit note" }, "Total": { "type": "number", "format": "double", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "format": "double", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "items": { "type": "object", "properties": { "AllocationID": { "type": "string", "description": "Xero generated unique identifier" }, "Invoice": { "type": "object" }, "Overpayment": { "type": "object" }, "Prepayment": { "type": "object" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Amount": { "type": "number", "description": "the amount being applied to the invoice" }, "Date": { "type": "string", "description": "the date the allocation is applied YYYY-MM-DD." }, "IsDeleted": { "type": "boolean", "description": "A flag that returns true when the allocation is succesfully deleted" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" } } }, "description": "See Allocations" }, "AppliedAmount": { "type": "number", "format": "double", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object", "description": "Circular schema reference: #/components/schemas/CreditNote" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Credit Notes" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_update\_or\_create\_invoices Updates or creates one or more sales invoices or purchase bills **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `unitdp` | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Invoices` | object\[] | No | — | The invoices value | | `pagination` | object | No | — | The pagination value | | `Warnings` | object\[] | No | — | Displays array of warning messages from the API | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "unitdp": { "type": "integer", "description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Invoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "InvoiceNumber": { "type": "string", "description": "ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "Url": { "type": "string", "description": "URL link to a source document – shown as “Go to [appName]” in the Xero app" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])" }, "Status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED" ], "description": "See Invoice Status Codes" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "string", "description": "Shown on sales invoices (Accounts Receivable) when this has been set" }, "PlannedPaymentDate": { "type": "string", "description": "Shown on bills (Accounts Payable) when this has been set" }, "CISDeduction": { "type": "number", "format": "double", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "format": "double", "description": "CIS Deduction rate for the organisation" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the invoice line items" }, "InvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for invoice" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoices" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if an invoice has an attachment" }, "IsDiscounted": { "type": "boolean", "description": "boolean to indicate if an invoice has a discount" }, "Payments": { "type": "array", "items": { "type": "object", "properties": { "Invoice": { "type": "object", "description": "Circular schema reference: #/components/schemas/Invoice" }, "CreditNote": { "type": "object" }, "Prepayment": { "type": "object" }, "Overpayment": { "type": "object" }, "InvoiceNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g.INV-4003" }, "CreditNoteNumber": { "type": "string", "description": "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, "BatchPayment": { "type": "object" }, "Account": { "type": "object" }, "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" }, "CurrencyRate": { "type": "number", "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500" }, "Amount": { "type": "number", "description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00" }, "BankAmount": { "type": "number", "description": "The amount of the payment in the currency of the bank account." }, "Reference": { "type": "string", "description": "An optional description for the payment e.g. Direct Debit" }, "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" }, "Status": { "type": "string", "description": "The status of the payment." }, "PaymentType": { "type": "string", "description": "See Payment Types." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the payment" }, "PaymentID": { "type": "string", "description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9" }, "BatchPaymentID": { "type": "string", "description": "Present if the payment was created as part of a batch." }, "BankAccountNumber": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Particulars": { "type": "string", "description": "The suppliers bank account number the payment is being made to" }, "Details": { "type": "string", "description": "The information to appear on the supplier's bank account" }, "HasAccount": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "HasValidationErrors": { "type": "boolean", "description": "A boolean to indicate if a contact has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" } } }, "description": "See Payments" }, "Prepayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Prepayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the prepayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Prepayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Prepayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the prepayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the prepayment" }, "Total": { "type": "number", "description": "The total of the prepayment(subtotal + total tax)" }, "Reference": { "type": "string", "description": "Returns Invoice number field. Reference field isn't available." }, "InvoiceNumber": { "type": "string", "description": "Returns Invoice number for prepayment receive document only." }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the prepayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "PrepaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "BrandingThemeID": { "type": "string", "description": "The unique identifier of the branding template applied to a receive prepayment" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the prepayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "Payments": { "type": "array", "description": "See Payments" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a prepayment has an attachment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Prepayments" }, "Overpayments": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Overpayment Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "The date the overpayment is created YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Overpayment Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Overpayment Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the overpayment excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the overpayment" }, "Total": { "type": "number", "description": "The total of the overpayment (subtotal + total tax)" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the overpayment" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "OverpaymentID": { "type": "string", "description": "Xero generated unique identifier" }, "CurrencyRate": { "type": "number", "description": "The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the overpayment" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a overpayment has an attachment" }, "Reference": { "type": "string", "description": "An optional description for Overpayment" }, "Attachments": { "type": "array", "description": "See Attachments" } } }, "description": "See Overpayments" }, "AmountDue": { "type": "number", "format": "double", "description": "Amount remaining to be paid on invoice" }, "AmountPaid": { "type": "number", "format": "double", "description": "Sum of payments received for invoice" }, "FullyPaidOnDate": { "type": "string", "description": "The date the invoice was fully paid. Only returned on fully paid invoices" }, "AmountCredited": { "type": "number", "format": "double", "description": "Sum of all credit notes, over-payments and pre-payments applied to invoice" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "CreditNotes": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "See Credit Note Types" }, "Contact": { "type": "object" }, "Date": { "type": "string", "description": "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": { "type": "string", "description": "Date invoice is due – YYYY-MM-DD" }, "Status": { "type": "string", "description": "See Credit Note Status Codes" }, "LineAmountTypes": { "type": "string", "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "LineItems": { "type": "array", "description": "See Invoice Line Items" }, "SubTotal": { "type": "number", "description": "The subtotal of the credit note excluding taxes" }, "TotalTax": { "type": "number", "description": "The total tax on the credit note" }, "Total": { "type": "number", "description": "The total of the Credit Note(subtotal + total tax)" }, "CISDeduction": { "type": "number", "description": "CIS deduction for UK contractors" }, "CISRate": { "type": "number", "description": "CIS Deduction rate for the organisation" }, "UpdatedDateUTC": { "type": "string", "description": "UTC timestamp of last update to the credit note" }, "CurrencyCode": { "type": "string", "description": "3 letter alpha code for the currency – see list of currency codes" }, "FullyPaidOnDate": { "type": "string", "description": "Date when credit note was fully paid(UTC format)" }, "CreditNoteID": { "type": "string", "description": "Xero generated unique identifier" }, "CreditNoteNumber": { "type": "string", "description": "ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)" }, "Reference": { "type": "string", "description": "ACCRECCREDIT only – additional reference number" }, "SentToContact": { "type": "boolean", "description": "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": { "type": "number", "description": "The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used" }, "RemainingCredit": { "type": "number", "description": "The remaining credit balance on the Credit Note" }, "Allocations": { "type": "array", "description": "See Allocations" }, "AppliedAmount": { "type": "number", "description": "The amount of applied to an invoice" }, "Payments": { "type": "array", "description": "See Payments" }, "BrandingThemeID": { "type": "string", "description": "See BrandingThemes" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "HasAttachments": { "type": "boolean", "description": "boolean to indicate if a credit note has an attachment" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a credit note has an validation errors" }, "ValidationErrors": { "type": "array", "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "Details of credit notes that have been applied to an invoice" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "HasErrors": { "type": "boolean", "description": "A boolean to indicate if a invoice has an validation errors" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" }, "InvoiceAddresses": { "type": "array", "items": { "type": "object", "properties": { "InvoiceAddressType": { "type": "string", "description": "Indicates whether the address is defined as origin (FROM) or destination (TO)" }, "AddressLine1": { "type": "string", "description": "First line of a physical address" }, "AddressLine2": { "type": "string", "description": "Second line of a physical address" }, "AddressLine3": { "type": "string", "description": "Third line of a physical address" }, "AddressLine4": { "type": "string", "description": "Fourth line of a physical address" }, "City": { "type": "string", "description": "City of a physical address" }, "Region": { "type": "string", "description": "Region or state of a physical address" }, "PostalCode": { "type": "string", "description": "Postal code of a physical address" }, "Country": { "type": "string", "description": "Country of a physical address" } } }, "description": "An array of addresses used to auto calculate sales tax" } } }, "description": "The invoices value" }, "pagination": { "type": "object", "description": "The pagination value", "properties": { "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "pageCount": { "type": "integer", "description": "Page Count" }, "itemCount": { "type": "integer", "description": "Item Count" } } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of warning messages from the API" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_update\_or\_create\_quotes Updates or creates one or more quotes **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `Quotes` | object\[] | No | — | The quotes value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "Quotes": { "type": "array", "items": { "type": "object", "properties": { "QuoteID": { "type": "string", "format": "uuid", "description": "QuoteID GUID is automatically generated and is returned after create or GET." }, "QuoteNumber": { "type": "string", "description": "Unique alpha numeric code identifying a quote (Max Length = 255)" }, "Reference": { "type": "string", "description": "Additional reference number" }, "Terms": { "type": "string", "description": "Terms of the quote" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "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" }, "DateString": { "type": "string", "description": "Date the quote was issued (YYYY-MM-DD)" }, "ExpiryDate": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "ExpiryDateString": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "Status": { "type": "string", "enum": [ "DRAFT", "SENT", "DECLINED", "ACCEPTED", "INVOICED", "DELETED" ], "description": "The status of the quote." }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency quote" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of quote excluding taxes." }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on quote" }, "Total": { "type": "number", "format": "double", "description": "Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the quote line items" }, "Title": { "type": "string", "description": "Title text for the quote" }, "Summary": { "type": "string", "description": "Summary text for the quote" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "LineAmountTypes": { "type": "string", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" } } }, "description": "The quotes value" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_update\_or\_create\_repeating\_invoices Creates or deletes one or more repeating invoice templates **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `summarizeErrors` | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `RepeatingInvoices` | object\[] | No | — | Repeating Invoices | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "summarizeErrors": { "type": "boolean", "description": "If false return 200 OK and mix of successfully created objects and any with validation errors" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "RepeatingInvoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCREC" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Schedule": { "type": "object", "description": "The schedule value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "Status": { "type": "string", "enum": [ "DRAFT", "AUTHORISED", "DELETED" ], "description": "One of the following - DRAFT or AUTHORISED – See Invoice Status Codes" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "ID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "HasAttachments": { "type": "boolean", "description": "Boolean to indicate if an invoice has an attachment" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "ApprovedForSending": { "type": "boolean", "description": "Boolean to indicate whether the invoice has been approved for sending" }, "SendCopy": { "type": "boolean", "description": "Boolean to indicate whether a copy is sent to sender's email" }, "MarkAsSent": { "type": "boolean", "description": "Boolean to indicate whether the invoice in the Xero app displays as \"sent\"" }, "IncludePDF": { "type": "boolean", "description": "Boolean to indicate whether to include PDF attachment" } } }, "description": "Repeating Invoices" } }, "required": [ "PCID", "xero-tenant-id" ] } ``` *** ## xero\_invoicing\_update\_quote Updates a specific quote **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `QuoteID` | string | Yes | — | Unique identifier for an Quote | | `Quotes` | object\[] | No | — | The quotes value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "QuoteID": { "type": "string", "description": "Unique identifier for an Quote" }, "Quotes": { "type": "array", "items": { "type": "object", "properties": { "QuoteID": { "type": "string", "format": "uuid", "description": "QuoteID GUID is automatically generated and is returned after create or GET." }, "QuoteNumber": { "type": "string", "description": "Unique alpha numeric code identifying a quote (Max Length = 255)" }, "Reference": { "type": "string", "description": "Additional reference number" }, "Terms": { "type": "string", "description": "Terms of the quote" }, "Contact": { "type": "object", "description": "The contact value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "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" }, "DateString": { "type": "string", "description": "Date the quote was issued (YYYY-MM-DD)" }, "ExpiryDate": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "ExpiryDateString": { "type": "string", "description": "Date the quote expires – YYYY-MM-DD." }, "Status": { "type": "string", "enum": [ "DRAFT", "SENT", "DECLINED", "ACCEPTED", "INVOICED", "DELETED" ], "description": "The status of the quote." }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "CurrencyRate": { "type": "number", "format": "double", "description": "The currency rate for a multicurrency quote" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of quote excluding taxes." }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on quote" }, "Total": { "type": "number", "format": "double", "description": "Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts" }, "TotalDiscount": { "type": "number", "format": "double", "description": "Total of discounts applied on the quote line items" }, "Title": { "type": "string", "description": "Title text for the quote" }, "Summary": { "type": "string", "description": "Summary text for the quote" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "UpdatedDateUTC": { "type": "string", "description": "Last modified date UTC format" }, "LineAmountTypes": { "type": "string", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "StatusAttributeString": { "type": "string", "description": "A string to indicate if a invoice status" }, "ValidationErrors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "description": "Validation error message" } } }, "description": "Displays array of validation error messages from the API" } } }, "description": "The quotes value" } }, "required": [ "PCID", "xero-tenant-id", "QuoteID" ] } ``` *** ## xero\_invoicing\_update\_repeating\_invoice Deletes a specific repeating invoice template **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `xero-tenant-id` | string | Yes | — | Xero identifier for Tenant | | `Idempotency-Key` | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | | `RepeatingInvoiceID` | string | Yes | — | Unique identifier for a Repeating Invoice | | `RepeatingInvoices` | object\[] | No | — | Repeating Invoices | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "xero-tenant-id": { "type": "string", "description": "Xero identifier for Tenant" }, "Idempotency-Key": { "type": "string", "description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max." }, "RepeatingInvoiceID": { "type": "string", "description": "Unique identifier for a Repeating Invoice" }, "RepeatingInvoices": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "ACCPAY", "ACCREC" ], "description": "See Invoice Types" }, "Contact": { "type": "object", "description": "The contact value" }, "Schedule": { "type": "object", "description": "The schedule value" }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "LineItemID": { "type": "string", "description": "LineItem unique ID" }, "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 element that contains at least 1 character" }, "Quantity": { "type": "number", "description": "LineItem Quantity" }, "UnitAmount": { "type": "number", "description": "LineItem Unit Amount" }, "ItemCode": { "type": "string", "description": "See Items" }, "AccountCode": { "type": "string", "description": "See Accounts" }, "AccountID": { "type": "string", "description": "The associated account ID related to this line item" }, "TaxType": { "type": "string", "description": "The tax type from TaxRates" }, "TaxAmount": { "type": "number", "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 is not correct." }, "Item": {}, "LineAmount": { "type": "number", "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" }, "Tracking": { "type": "array", "description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements." }, "DiscountRate": { "type": "number", "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", "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", "description": "The Xero identifier for a Repeating Invoice" }, "Taxability": { "type": "string", "description": "The type of taxability" }, "SalesTaxCodeId": { "type": "number", "description": "The ID of the sales tax code" }, "TaxBreakdown": { "type": "array", "description": "An array of tax components defined for this line item" } } }, "description": "See LineItems" }, "LineAmountTypes": { "type": "string", "enum": [ "Exclusive", "Inclusive", "NoTax" ], "description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types" }, "Reference": { "type": "string", "description": "ACCREC only – additional reference number" }, "BrandingThemeID": { "type": "string", "format": "uuid", "description": "See BrandingThemes" }, "CurrencyCode": { "type": "string", "enum": [ "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" ], "description": "3 letter alpha code for the currency – see list of currency codes" }, "Status": { "type": "string", "enum": [ "DRAFT", "AUTHORISED", "DELETED" ], "description": "One of the following - DRAFT or AUTHORISED – See Invoice Status Codes" }, "SubTotal": { "type": "number", "format": "double", "description": "Total of invoice excluding taxes" }, "TotalTax": { "type": "number", "format": "double", "description": "Total tax on invoice" }, "Total": { "type": "number", "format": "double", "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)" }, "RepeatingInvoiceID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "ID": { "type": "string", "format": "uuid", "description": "Xero generated unique identifier for repeating invoice template" }, "HasAttachments": { "type": "boolean", "description": "Boolean to indicate if an invoice has an attachment" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentID": { "type": "string", "description": "Unique ID for the file" }, "FileName": { "type": "string", "description": "Name of the file" }, "Url": { "type": "string", "description": "URL to the file on xero.com" }, "MimeType": { "type": "string", "description": "Type of file" }, "ContentLength": { "type": "integer", "description": "Length of the file content" }, "IncludeOnline": { "type": "boolean", "description": "Include the file with the online invoice" } } }, "description": "Displays array of attachments from the API" }, "ApprovedForSending": { "type": "boolean", "description": "Boolean to indicate whether the invoice has been approved for sending" }, "SendCopy": { "type": "boolean", "description": "Boolean to indicate whether a copy is sent to sender's email" }, "MarkAsSent": { "type": "boolean", "description": "Boolean to indicate whether the invoice in the Xero app displays as \"sent\"" }, "IncludePDF": { "type": "boolean", "description": "Boolean to indicate whether to include PDF attachment" } } }, "description": "Repeating Invoices" } }, "required": [ "PCID", "xero-tenant-id", "RepeatingInvoiceID" ] } ```