/xero-payments | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
xero_payments_create_bank_transactions | Creates one or more spent or received money transaction |
xero_payments_create_bank_transfer | Creates a bank transfer |
xero_payments_create_batch_payment | Creates one or many batch payments for invoices |
xero_payments_create_linked_transaction | Creates linked transactions (billable expenses) |
xero_payments_create_overpayment_allocations | Creates a single allocation for a specific overpayment |
xero_payments_create_payment | Creates a single payment for invoice or credit notes |
xero_payments_create_payments | Creates multiple payments for invoices or credit notes |
xero_payments_create_prepayment_allocations | Allows you to create an Allocation for prepayments |
xero_payments_delete_batch_payment | Updates a specific batch payment for invoices and credit notes |
xero_payments_delete_batch_payment_by_url_param | Updates a specific batch payment for invoices and credit notes |
xero_payments_delete_linked_transaction | Deletes a specific linked transactions (billable expenses) |
xero_payments_delete_overpayment_allocations | Deletes an Allocation from an overpayment |
xero_payments_delete_payment | Updates a specific payment for invoices and credit notes |
xero_payments_delete_prepayment_allocations | Deletes an Allocation from a Prepayment |
xero_payments_get_bank_transaction | Retrieves a single spent or received money transaction by using a unique bank transaction Id |
xero_payments_get_bank_transactions | Retrieves any spent or received money transactions |
xero_payments_get_bank_transfer | Retrieves specific bank transfers by using a unique bank transfer Id |
xero_payments_get_bank_transfers | Retrieves all bank transfers |
xero_payments_get_batch_payment | Retrieves a specific batch payment using a unique batch payment Id |
xero_payments_get_batch_payments | Retrieves either one or many batch payments for invoices |
xero_payments_get_linked_transaction | Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id |
xero_payments_get_linked_transactions | Retrieves linked transactions (billable expenses) |
xero_payments_get_overpayment | Retrieves a specific overpayment using a unique overpayment Id |
xero_payments_get_overpayments | Retrieves overpayments |
xero_payments_get_payment | Retrieves a specific payment for invoices and credit notes using a unique payment Id |
xero_payments_get_payments | Retrieves payments for invoices and credit notes |
xero_payments_get_prepayment | Allows you to retrieve a specified prepayments |
xero_payments_get_prepayments | Retrieves prepayments |
xero_payments_update_bank_transaction | Updates a single spent or received money transaction |
xero_payments_update_linked_transaction | Updates a specific linked transactions (billable expenses) |
xero_payments_update_or_create_bank_transactions | Updates or creates one or more spent or received money transaction |
xero_payments_create_bank_transactions
Creates one or more spent or received money transaction 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. |
BankTransactions | object[] | No | — | Bank Transactions |
pagination | object | No | — | The pagination value |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"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."
},
"BankTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"RECEIVE",
"RECEIVE-OVERPAYMENT",
"RECEIVE-PREPAYMENT",
"SPEND",
"SPEND-OVERPAYMENT",
"SPEND-PREPAYMENT",
"RECEIVE-TRANSFER",
"SPEND-TRANSFER"
],
"description": "See Bank Transaction 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 <Description> 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 <TaxAmount> 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 <TrackingCategory> 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"
},
"BankAccount": {
"type": "object",
"description": "Bank Account"
},
"IsReconciled": {
"type": "boolean",
"description": "Boolean to show if transaction is reconciled"
},
"Date": {
"type": "string",
"description": "Date of transaction – YYYY-MM-DD"
},
"Reference": {
"type": "string",
"description": "Reference for the transaction. Only supported for SPEND and RECEIVE transactions."
},
"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": "Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments."
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to App Name”"
},
"Status": {
"type": "string",
"enum": [
"AUTHORISED",
"DELETED",
"VOIDED"
],
"description": "See Bank Transaction 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"
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of bank transaction excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on bank transaction"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of bank transaction tax inclusive"
},
"BankTransactionID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for bank transaction"
},
"PrepaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT"
},
"OverpaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "Boolean to indicate if a bank transaction has an attachment"
},
"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": [
"Type",
"LineItems",
"BankAccount"
]
},
"description": "Bank Transactions"
},
"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_payments_create_bank_transfer
Creates a bank transfer 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. |
BankTransfers | object[] | No | — | Bank Transfers |
Show inputSchema
Show inputSchema
{
"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."
},
"BankTransfers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"FromBankAccount": {
"type": "object",
"description": "From Bank Account"
},
"ToBankAccount": {
"type": "object",
"description": "To Bank Account"
},
"Amount": {
"type": "number",
"format": "double",
"description": "amount of the transaction"
},
"Date": {
"type": "string",
"description": "The date of the Transfer YYYY-MM-DD"
},
"BankTransferID": {
"type": "string",
"format": "uuid",
"description": "The identifier of the Bank Transfer"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"description": "The currency rate"
},
"FromBankTransactionID": {
"type": "string",
"format": "uuid",
"description": "The Bank Transaction ID for the source account"
},
"ToBankTransactionID": {
"type": "string",
"format": "uuid",
"description": "The Bank Transaction ID for the destination account"
},
"FromIsReconciled": {
"type": "boolean",
"description": "The Bank Transaction boolean to show if it is reconciled for the source account"
},
"ToIsReconciled": {
"type": "boolean",
"description": "The Bank Transaction boolean to show if it is reconciled for the destination account"
},
"Reference": {
"type": "string",
"description": "Reference for the transactions."
},
"HasAttachments": {
"type": "boolean",
"description": "Boolean to indicate if a Bank Transfer has an attachment"
},
"CreatedDateUTC": {
"type": "string",
"description": "UTC timestamp of creation date of bank transfer"
},
"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": [
"FromBankAccount",
"ToBankAccount",
"Amount"
]
},
"description": "Bank Transfers"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_create_batch_payment
Creates one or many batch payments for invoices 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. |
BatchPayments | object[] | No | — | Batch Payments |
Show inputSchema
Show inputSchema
{
"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."
},
"BatchPayments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Account": {
"type": "object",
"description": "The account value"
},
"Reference": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Particulars": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Code": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Details": {
"type": "string",
"description": "(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18"
},
"Narrative": {
"type": "string",
"description": "(UK Only) Only shows on the statement line in Xero. Max length =18"
},
"BatchPaymentID": {
"type": "string",
"format": "uuid",
"description": "The Xero generated unique identifier for the bank transaction (read-only)"
},
"DateString": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"Amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00"
},
"Payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Invoice": {
"type": "object"
},
"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",
"description": "Circular schema reference: #/components/schemas/BatchPayment"
},
"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": "An array of payments"
},
"Type": {
"type": "string",
"enum": [
"PAYBATCH",
"RECBATCH"
],
"description": "PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)"
},
"Status": {
"type": "string",
"enum": [
"AUTHORISED",
"DELETED"
],
"description": "AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API."
},
"TotalAmount": {
"type": "number",
"format": "double",
"description": "The total of the payments that make up the batch (read-only)"
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"IsReconciled": {
"type": "boolean",
"description": "Booelan that tells you if the batch payment has been reconciled (read-only)"
},
"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": "Batch Payments"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_create_linked_transaction
Creates linked transactions (billable expenses) 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. |
ContactID | string | No | — | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. |
LinkedTransactionID | string | No | — | The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
SourceLineItemID | string | No | — | The line item identifier from the source transaction. |
SourceTransactionID | string | No | — | Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice |
SourceTransactionTypeCode | string | No | — | The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction. |
Status | string | No | — | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. |
TargetLineItemID | string | No | — | The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. |
TargetTransactionID | string | No | — | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice |
Type | string | No | — | This will always be BILLABLEEXPENSE. More types may be added in future. |
UpdatedDateUTC | string | No | — | The last modified date in UTC format |
ValidationErrors | object[] | No | — | Displays array of validation error messages from the API |
Show inputSchema
Show inputSchema
{
"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."
},
"ContactID": {
"type": "string",
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED."
},
"LinkedTransactionID": {
"type": "string",
"description": "The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"SourceLineItemID": {
"type": "string",
"description": "The line item identifier from the source transaction."
},
"SourceTransactionID": {
"type": "string",
"description": "Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice"
},
"SourceTransactionTypeCode": {
"type": "string",
"description": "The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction.",
"enum": [
"ACCPAY",
"SPEND"
]
},
"Status": {
"type": "string",
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.",
"enum": [
"APPROVED",
"DRAFT",
"ONDRAFT",
"BILLED",
"VOIDED"
]
},
"TargetLineItemID": {
"type": "string",
"description": "The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID."
},
"TargetTransactionID": {
"type": "string",
"description": "Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice"
},
"Type": {
"type": "string",
"description": "This will always be BILLABLEEXPENSE. More types may be added in future.",
"enum": [
"BILLABLEEXPENSE"
]
},
"UpdatedDateUTC": {
"type": "string",
"description": "The last modified date in UTC format"
},
"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": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_create_overpayment_allocations
Creates a single allocation for a specific overpayment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
OverpaymentID | string | Yes | — | Unique identifier for a Overpayment |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"OverpaymentID": {
"type": "string",
"description": "Unique identifier for a Overpayment"
},
"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",
"OverpaymentID"
]
}
xero_payments_create_payment
Creates a single payment for invoice or credit notes 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. |
Account | object | No | — | The account value |
Amount | number | No | — | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 |
BankAccountNumber | string | No | — | The suppliers bank account number the payment is being made to |
BankAmount | number | No | — | The amount of the payment in the currency of the bank account. |
BatchPayment | object | No | — | Batch Payment |
BatchPaymentID | string | No | — | Present if the payment was created as part of a batch. |
Code | string | No | — | Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) |
CreditNote | object | No | — | Credit Note |
CreditNoteNumber | string | No | — | Number of invoice or credit note you are applying payment to e.g. INV-4003 |
CurrencyRate | number | No | — | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 |
Date | string | No | — | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 |
Details | string | No | — | The information to appear on the supplier’s bank account |
HasAccount | boolean | No | — | A boolean to indicate if a contact has an validation errors |
HasValidationErrors | boolean | No | — | A boolean to indicate if a contact has an validation errors |
Invoice | object | No | — | The invoice value |
InvoiceNumber | string | No | — | Number of invoice or credit note you are applying payment to e.g.INV-4003 |
IsReconciled | boolean | No | — | An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET |
Overpayment | object | No | — | The overpayment value |
Particulars | string | No | — | The suppliers bank account number the payment is being made to |
PaymentID | string | No | — | The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
PaymentType | string | No | — | See Payment Types. |
Prepayment | object | No | — | The prepayment value |
Reference | string | No | — | An optional description for the payment e.g. Direct Debit |
Status | string | No | — | The status of the payment. |
StatusAttributeString | string | No | — | A string to indicate if a invoice status |
UpdatedDateUTC | string | No | — | UTC timestamp of last update to the payment |
ValidationErrors | object[] | No | — | Displays array of validation error messages from the API |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"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."
},
"Account": {
"type": "object",
"description": "The account value",
"properties": {
"Code": {
"type": "string",
"description": "Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)"
},
"Name": {
"type": "string",
"description": "Name of account (max length = 150)"
},
"AccountID": {
"type": "string",
"description": "The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"Type": {
"type": "string",
"description": "See Account Types",
"enum": [
"BANK",
"CURRENT",
"CURRLIAB",
"DEPRECIATN",
"DIRECTCOSTS",
"EQUITY",
"EXPENSE",
"FIXED",
"INVENTORY",
"LIABILITY",
"NONCURRENT",
"OTHERINCOME",
"OVERHEADS",
"PREPAYMENT",
"REVENUE",
"SALES",
"TERMLIAB",
"PAYG"
]
},
"BankAccountNumber": {
"type": "string",
"description": "For bank accounts only (Account Type BANK)"
},
"Status": {
"type": "string",
"description": "Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes",
"enum": [
"ACTIVE",
"ARCHIVED",
"DELETED"
]
},
"Description": {
"type": "string",
"description": "Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)"
},
"BankAccountType": {
"type": "string",
"description": "For bank accounts only. See Bank Account types",
"enum": [
"BANK",
"CREDITCARD",
"PAYPAL",
"NONE",
""
]
},
"CurrencyCode": {
"type": "string",
"description": "3 letter alpha code for the currency – see list of currency codes",
"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"
]
},
"TaxType": {
"type": "string",
"description": "The tax type from taxRates"
},
"EnablePaymentsToAccount": {
"type": "boolean",
"description": "Boolean – describes whether account can have payments applied to it"
},
"ShowInExpenseClaims": {
"type": "boolean",
"description": "Boolean – describes whether account code is available for use with expense claims"
},
"Class": {
"type": "string",
"description": "See Account Class Types",
"enum": [
"ASSET",
"EQUITY",
"EXPENSE",
"LIABILITY",
"REVENUE"
]
},
"SystemAccount": {
"type": "string",
"description": "If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.",
"enum": [
"DEBTORS",
"CREDITORS",
"BANKCURRENCYGAIN",
"GST",
"GSTONIMPORTS",
"HISTORICAL",
"REALISEDCURRENCYGAIN",
"RETAINEDEARNINGS",
"ROUNDING",
"TRACKINGTRANSFERS",
"UNPAIDEXPCLM",
"UNREALISEDCURRENCYGAIN",
"WAGEPAYABLES",
"CISASSETS",
"CISASSET",
"CISLABOUR",
"CISLABOUREXPENSE",
"CISLABOURINCOME",
"CISLIABILITY",
"CISMATERIALS",
""
]
},
"ReportingCode": {
"type": "string",
"description": "Shown if set"
},
"ReportingCodeName": {
"type": "string",
"description": "Shown if set"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if an account has an attachment (read only)"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"AddToWatchlist": {
"type": "boolean",
"description": "Boolean – describes whether the account is shown in the watchlist widget on the dashboard"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object"
},
"description": "Displays array of validation error messages from the API"
}
}
},
"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"
},
"BankAccountNumber": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"BankAmount": {
"type": "number",
"description": "The amount of the payment in the currency of the bank account."
},
"BatchPayment": {
"type": "object",
"description": "Batch Payment",
"properties": {
"Account": {
"type": "object",
"description": "The account value"
},
"Reference": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Particulars": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Code": {
"type": "string",
"description": "(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero."
},
"Details": {
"type": "string",
"description": "(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18"
},
"Narrative": {
"type": "string",
"description": "(UK Only) Only shows on the statement line in Xero. Max length =18"
},
"BatchPaymentID": {
"type": "string",
"description": "The Xero generated unique identifier for the bank transaction (read-only)"
},
"DateString": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"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"
},
"Payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of payments"
},
"Type": {
"type": "string",
"description": "PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)",
"enum": [
"PAYBATCH",
"RECBATCH"
]
},
"Status": {
"type": "string",
"description": "AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API.",
"enum": [
"AUTHORISED",
"DELETED"
]
},
"TotalAmount": {
"type": "number",
"description": "The total of the payments that make up the batch (read-only)"
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"IsReconciled": {
"type": "boolean",
"description": "Booelan that tells you if the batch payment has been reconciled (read-only)"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object"
},
"description": "Displays array of validation error messages from the API"
}
}
},
"BatchPaymentID": {
"type": "string",
"description": "Present if the payment was created as part of a batch."
},
"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)"
},
"CreditNote": {
"type": "object",
"description": "Credit Note",
"properties": {
"Type": {
"type": "string",
"description": "See Credit Note Types",
"enum": [
"ACCPAYCREDIT",
"ACCRECCREDIT"
]
},
"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",
"description": "See Credit Note Status Codes",
"enum": [
"DRAFT",
"SUBMITTED",
"DELETED",
"AUTHORISED",
"PAID",
"VOIDED"
]
},
"LineAmountTypes": {
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
]
},
"LineItems": {
"type": "array",
"items": {
"type": "object"
},
"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",
"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"
]
},
"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",
"items": {
"type": "object"
},
"description": "See Allocations"
},
"AppliedAmount": {
"type": "number",
"description": "The amount of applied to an invoice"
},
"Payments": {
"type": "array",
"items": {
"type": "object"
},
"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",
"items": {
"type": "object"
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object"
},
"description": "Displays array of warning messages from the API"
},
"InvoiceAddresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of addresses used to auto calculate sales tax"
}
}
},
"CreditNoteNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g. INV-4003"
},
"CurrencyRate": {
"type": "number",
"description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"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"
},
"Invoice": {
"type": "object",
"description": "The invoice value",
"properties": {
"Type": {
"type": "string",
"description": "See Invoice Types",
"enum": [
"ACCPAY",
"ACCPAYCREDIT",
"APOVERPAYMENT",
"APPREPAYMENT",
"ACCREC",
"ACCRECCREDIT",
"AROVERPAYMENT",
"ARPREPAYMENT"
]
},
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object"
},
"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",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
]
},
"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",
"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",
"description": "3 letter alpha code for the currency – see list of currency codes",
"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"
]
},
"CurrencyRate": {
"type": "number",
"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",
"description": "See Invoice Status Codes",
"enum": [
"DRAFT",
"SUBMITTED",
"DELETED",
"AUTHORISED",
"PAID",
"VOIDED"
]
},
"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",
"description": "CIS deduction for UK contractors"
},
"CISRate": {
"type": "number",
"description": "CIS Deduction rate for the organisation"
},
"SubTotal": {
"type": "number",
"description": "Total of invoice excluding taxes"
},
"TotalTax": {
"type": "number",
"description": "Total tax on invoice"
},
"Total": {
"type": "number",
"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",
"description": "Total of discounts applied on the invoice line items"
},
"InvoiceID": {
"type": "string",
"description": "Xero generated unique identifier for invoice"
},
"RepeatingInvoiceID": {
"type": "string",
"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"
},
"description": "See Payments"
},
"Prepayments": {
"type": "array",
"items": {
"type": "object"
},
"description": "See Prepayments"
},
"Overpayments": {
"type": "array",
"items": {
"type": "object"
},
"description": "See Overpayments"
},
"AmountDue": {
"type": "number",
"description": "Amount remaining to be paid on invoice"
},
"AmountPaid": {
"type": "number",
"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",
"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"
},
"description": "Details of credit notes that have been applied to an invoice"
},
"Attachments": {
"type": "array",
"items": {
"type": "object"
},
"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"
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object"
},
"description": "Displays array of warning messages from the API"
},
"InvoiceAddresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of addresses used to auto calculate sales tax"
}
}
},
"InvoiceNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g.INV-4003"
},
"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"
},
"Overpayment": {
"type": "object",
"description": "The overpayment value",
"properties": {
"Type": {
"type": "string",
"description": "See Overpayment Types",
"enum": [
"RECEIVE-OVERPAYMENT",
"SPEND-OVERPAYMENT",
"AROVERPAYMENT"
]
},
"Contact": {
"type": "object",
"description": "The contact value"
},
"Date": {
"type": "string",
"description": "The date the overpayment is created YYYY-MM-DD"
},
"Status": {
"type": "string",
"description": "See Overpayment Status Codes",
"enum": [
"AUTHORISED",
"PAID",
"VOIDED"
]
},
"LineAmountTypes": {
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
]
},
"LineItems": {
"type": "array",
"items": {
"type": "object"
},
"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",
"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"
]
},
"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",
"items": {
"type": "object"
},
"description": "See Allocations"
},
"AppliedAmount": {
"type": "number",
"description": "The amount of applied to an invoice"
},
"Payments": {
"type": "array",
"items": {
"type": "object"
},
"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",
"items": {
"type": "object"
},
"description": "See Attachments"
}
}
},
"Particulars": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"PaymentID": {
"type": "string",
"description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"PaymentType": {
"type": "string",
"description": "See Payment Types.",
"enum": [
"ACCRECPAYMENT",
"ACCPAYPAYMENT",
"ARCREDITPAYMENT",
"APCREDITPAYMENT",
"AROVERPAYMENTPAYMENT",
"ARPREPAYMENTPAYMENT",
"APPREPAYMENTPAYMENT",
"APOVERPAYMENTPAYMENT"
]
},
"Prepayment": {
"type": "object",
"description": "The prepayment value",
"properties": {
"Type": {
"type": "string",
"description": "See Prepayment Types",
"enum": [
"RECEIVE-PREPAYMENT",
"SPEND-PREPAYMENT",
"ARPREPAYMENT",
"APPREPAYMENT"
]
},
"Contact": {
"type": "object",
"description": "The contact value"
},
"Date": {
"type": "string",
"description": "The date the prepayment is created YYYY-MM-DD"
},
"Status": {
"type": "string",
"description": "See Prepayment Status Codes",
"enum": [
"AUTHORISED",
"PAID",
"VOIDED"
]
},
"LineAmountTypes": {
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
]
},
"LineItems": {
"type": "array",
"items": {
"type": "object"
},
"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",
"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"
]
},
"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",
"items": {
"type": "object"
},
"description": "See Allocations"
},
"Payments": {
"type": "array",
"items": {
"type": "object"
},
"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",
"items": {
"type": "object"
},
"description": "See Attachments"
}
}
},
"Reference": {
"type": "string",
"description": "An optional description for the payment e.g. Direct Debit"
},
"Status": {
"type": "string",
"description": "The status of the payment.",
"enum": [
"AUTHORISED",
"DELETED"
]
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"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"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_create_payments
Creates multiple payments for invoices or 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 |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
pagination | object | No | — | The pagination value |
Payments | object[] | No | — | The payments value |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"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."
},
"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"
}
}
},
"Payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Invoice": {
"type": "object",
"description": "The invoice value"
},
"CreditNote": {
"type": "object",
"description": "Credit Note"
},
"Prepayment": {
"type": "object",
"description": "The prepayment value"
},
"Overpayment": {
"type": "object",
"description": "The overpayment value"
},
"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",
"description": "Batch Payment"
},
"Account": {
"type": "object",
"description": "The account value"
},
"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",
"format": "double",
"description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500"
},
"Amount": {
"type": "number",
"format": "double",
"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",
"format": "double",
"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",
"enum": [
"AUTHORISED",
"DELETED"
],
"description": "The status of the payment."
},
"PaymentType": {
"type": "string",
"enum": [
"ACCRECPAYMENT",
"ACCPAYPAYMENT",
"ARCREDITPAYMENT",
"APCREDITPAYMENT",
"AROVERPAYMENTPAYMENT",
"ARPREPAYMENTPAYMENT",
"APPREPAYMENTPAYMENT",
"APOVERPAYMENTPAYMENT"
],
"description": "See Payment Types."
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"PaymentID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"BatchPaymentID": {
"type": "string",
"format": "uuid",
"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",
"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"
}
}
},
"description": "The payments value"
},
"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_payments_create_prepayment_allocations
Allows you to create an Allocation for prepayments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PrepaymentID | string | Yes | — | Unique identifier for a PrePayment |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PrepaymentID": {
"type": "string",
"description": "Unique identifier for a PrePayment"
},
"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",
"PrepaymentID"
]
}
xero_payments_delete_batch_payment
Updates a specific batch payment for invoices and credit notes 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. |
BatchPaymentID | string | Yes | — | The Xero generated unique identifier for the bank transaction (read-only) |
Status | string | Yes | — | The status of the batch payment. |
Show inputSchema
Show inputSchema
{
"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."
},
"BatchPaymentID": {
"type": "string",
"description": "The Xero generated unique identifier for the bank transaction (read-only)"
},
"Status": {
"type": "string",
"description": "The status of the batch payment."
}
},
"required": [
"PCID",
"xero-tenant-id",
"BatchPaymentID",
"Status"
]
}
xero_payments_delete_batch_payment_by_url_param
Updates a specific batch payment for invoices and credit notes 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. |
BatchPaymentID | string | Yes | — | Unique identifier for BatchPayment |
Status | string | Yes | — | The status of the batch payment. |
Show inputSchema
Show inputSchema
{
"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."
},
"BatchPaymentID": {
"type": "string",
"description": "Unique identifier for BatchPayment"
},
"Status": {
"type": "string",
"description": "The status of the batch payment."
}
},
"required": [
"PCID",
"xero-tenant-id",
"BatchPaymentID",
"Status"
]
}
xero_payments_delete_linked_transaction
Deletes a specific linked transactions (billable expenses) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
LinkedTransactionID | string | Yes | — | Unique identifier for a LinkedTransaction |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"LinkedTransactionID": {
"type": "string",
"description": "Unique identifier for a LinkedTransaction"
}
},
"required": [
"PCID",
"xero-tenant-id",
"LinkedTransactionID"
]
}
xero_payments_delete_overpayment_allocations
Deletes an Allocation from an overpayment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
OverpaymentID | string | Yes | — | Unique identifier for a Overpayment |
AllocationID | string | Yes | — | Unique identifier for Allocation object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"OverpaymentID": {
"type": "string",
"description": "Unique identifier for a Overpayment"
},
"AllocationID": {
"type": "string",
"description": "Unique identifier for Allocation object"
}
},
"required": [
"PCID",
"xero-tenant-id",
"OverpaymentID",
"AllocationID"
]
}
xero_payments_delete_payment
Updates a specific payment for invoices and credit notes 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. |
PaymentID | string | Yes | — | Unique identifier for a Payment |
Status | string | Yes | — | The status of the payment. |
Show inputSchema
Show inputSchema
{
"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."
},
"PaymentID": {
"type": "string",
"description": "Unique identifier for a Payment"
},
"Status": {
"type": "string",
"description": "The status of the payment."
}
},
"required": [
"PCID",
"xero-tenant-id",
"PaymentID",
"Status"
]
}
xero_payments_delete_prepayment_allocations
Deletes an Allocation from a Prepayment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PrepaymentID | string | Yes | — | Unique identifier for a PrePayment |
AllocationID | string | Yes | — | Unique identifier for Allocation object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PrepaymentID": {
"type": "string",
"description": "Unique identifier for a PrePayment"
},
"AllocationID": {
"type": "string",
"description": "Unique identifier for Allocation object"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PrepaymentID",
"AllocationID"
]
}
xero_payments_get_bank_transaction
Retrieves a single spent or received money transaction by using a unique bank transaction Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
BankTransactionID | string | Yes | — | Xero generated unique identifier for a bank transaction |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"BankTransactionID": {
"type": "string",
"description": "Xero generated unique identifier for a bank transaction"
},
"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",
"BankTransactionID"
]
}
xero_payments_get_bank_transactions
Retrieves any spent or received money transactions 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 | — | Up to 100 bank transactions will be returned in a single API call with line items details |
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 |
Show inputSchema
Show inputSchema
{
"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": "Up to 100 bank transactions will be returned in a single API call with line items details"
},
"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_payments_get_bank_transfer
Retrieves specific bank transfers by using a unique bank transfer Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
BankTransferID | string | Yes | — | Xero generated unique identifier for a bank transfer |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"BankTransferID": {
"type": "string",
"description": "Xero generated unique identifier for a bank transfer"
}
},
"required": [
"PCID",
"xero-tenant-id",
"BankTransferID"
]
}
xero_payments_get_bank_transfers
Retrieves all bank transfers 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 |
Show inputSchema
Show inputSchema
{
"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"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_get_batch_payment
Retrieves a specific batch payment using a unique batch payment Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
BatchPaymentID | string | Yes | — | Unique identifier for BatchPayment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"BatchPaymentID": {
"type": "string",
"description": "Unique identifier for BatchPayment"
}
},
"required": [
"PCID",
"xero-tenant-id",
"BatchPaymentID"
]
}
xero_payments_get_batch_payments
Retrieves either one or many batch payments for invoices 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 |
Show inputSchema
Show inputSchema
{
"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"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_get_linked_transaction
Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
LinkedTransactionID | string | Yes | — | Unique identifier for a LinkedTransaction |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"LinkedTransactionID": {
"type": "string",
"description": "Unique identifier for a LinkedTransaction"
}
},
"required": [
"PCID",
"xero-tenant-id",
"LinkedTransactionID"
]
}
xero_payments_get_linked_transactions
Retrieves linked transactions (billable expenses) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
page | integer | No | — | Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. |
LinkedTransactionID | string | No | — | The Xero identifier for an Linked Transaction |
SourceTransactionID | string | No | — | Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice |
ContactID | string | No | — | Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. |
Status | string | No | — | Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status |
TargetTransactionID | string | No | — | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"page": {
"type": "integer",
"description": "Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1."
},
"LinkedTransactionID": {
"type": "string",
"description": "The Xero identifier for an Linked Transaction"
},
"SourceTransactionID": {
"type": "string",
"description": "Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice"
},
"ContactID": {
"type": "string",
"description": "Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer."
},
"Status": {
"type": "string",
"description": "Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status"
},
"TargetTransactionID": {
"type": "string",
"description": "Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_get_overpayment
Retrieves a specific overpayment using a unique overpayment Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
OverpaymentID | string | Yes | — | Unique identifier for a Overpayment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"OverpaymentID": {
"type": "string",
"description": "Unique identifier for a Overpayment"
}
},
"required": [
"PCID",
"xero-tenant-id",
"OverpaymentID"
]
}
xero_payments_get_overpayments
Retrieves overpayments 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 overpayments will be returned in a single API call with line items shown for each overpayment |
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 |
References | string[] | No | — | Filter by a comma-separated list of References |
Show inputSchema
Show inputSchema
{
"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 overpayments will be returned in a single API call with line items shown for each overpayment"
},
"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"
},
"References": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by a comma-separated list of References"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_get_payment
Retrieves a specific payment for invoices and credit notes using a unique payment Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PaymentID | string | Yes | — | Unique identifier for a Payment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PaymentID": {
"type": "string",
"description": "Unique identifier for a Payment"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PaymentID"
]
}
xero_payments_get_payments
Retrieves payments for invoices and 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 | — | Up to 100 payments will be returned in a single API call |
pageSize | integer | No | — | Number of records to retrieve per page |
Show inputSchema
Show inputSchema
{
"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": "Up to 100 payments will be returned in a single API call"
},
"pageSize": {
"type": "integer",
"description": "Number of records to retrieve per page"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_get_prepayment
Allows you to retrieve a specified prepayments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PrepaymentID | string | Yes | — | Unique identifier for a PrePayment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PrepaymentID": {
"type": "string",
"description": "Unique identifier for a PrePayment"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PrepaymentID"
]
}
xero_payments_get_prepayments
Retrieves prepayments 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 prepayments will be returned in a single API call with line items shown for each overpayment |
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 |
InvoiceNumbers | string[] | No | — | Filter by a comma-separated list of InvoiceNumbers |
Show inputSchema
Show inputSchema
{
"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 prepayments will be returned in a single API call with line items shown for each overpayment"
},
"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"
},
"InvoiceNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by a comma-separated list of InvoiceNumbers"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_payments_update_bank_transaction
Updates a single spent or received money transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
BankTransactionID | string | Yes | — | Xero generated unique identifier for a bank transaction |
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. |
BankTransactions | object[] | No | — | Bank Transactions |
pagination | object | No | — | The pagination value |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"BankTransactionID": {
"type": "string",
"description": "Xero generated unique identifier for a bank transaction"
},
"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."
},
"BankTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"RECEIVE",
"RECEIVE-OVERPAYMENT",
"RECEIVE-PREPAYMENT",
"SPEND",
"SPEND-OVERPAYMENT",
"SPEND-PREPAYMENT",
"RECEIVE-TRANSFER",
"SPEND-TRANSFER"
],
"description": "See Bank Transaction 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 <Description> 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 <TaxAmount> 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 <TrackingCategory> 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"
},
"BankAccount": {
"type": "object",
"description": "Bank Account"
},
"IsReconciled": {
"type": "boolean",
"description": "Boolean to show if transaction is reconciled"
},
"Date": {
"type": "string",
"description": "Date of transaction – YYYY-MM-DD"
},
"Reference": {
"type": "string",
"description": "Reference for the transaction. Only supported for SPEND and RECEIVE transactions."
},
"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": "Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments."
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to App Name”"
},
"Status": {
"type": "string",
"enum": [
"AUTHORISED",
"DELETED",
"VOIDED"
],
"description": "See Bank Transaction 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"
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of bank transaction excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on bank transaction"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of bank transaction tax inclusive"
},
"BankTransactionID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for bank transaction"
},
"PrepaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT"
},
"OverpaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "Boolean to indicate if a bank transaction has an attachment"
},
"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": [
"Type",
"LineItems",
"BankAccount"
]
},
"description": "Bank Transactions"
},
"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",
"BankTransactionID"
]
}
xero_payments_update_linked_transaction
Updates a specific linked transactions (billable expenses) 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. |
LinkedTransactionID | string | Yes | — | Unique identifier for a LinkedTransaction |
LinkedTransactions | object[] | No | — | Linked Transactions |
Show inputSchema
Show inputSchema
{
"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."
},
"LinkedTransactionID": {
"type": "string",
"description": "Unique identifier for a LinkedTransaction"
},
"LinkedTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"SourceTransactionID": {
"type": "string",
"format": "uuid",
"description": "Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice"
},
"SourceLineItemID": {
"type": "string",
"format": "uuid",
"description": "The line item identifier from the source transaction."
},
"ContactID": {
"type": "string",
"format": "uuid",
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED."
},
"TargetTransactionID": {
"type": "string",
"format": "uuid",
"description": "Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice"
},
"TargetLineItemID": {
"type": "string",
"format": "uuid",
"description": "The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID."
},
"LinkedTransactionID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"Status": {
"type": "string",
"enum": [
"APPROVED",
"DRAFT",
"ONDRAFT",
"BILLED",
"VOIDED"
],
"description": "Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED."
},
"Type": {
"type": "string",
"enum": [
"BILLABLEEXPENSE"
],
"description": "This will always be BILLABLEEXPENSE. More types may be added in future."
},
"UpdatedDateUTC": {
"type": "string",
"description": "The last modified date in UTC format"
},
"SourceTransactionTypeCode": {
"type": "string",
"enum": [
"ACCPAY",
"SPEND"
],
"description": "The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction."
},
"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": "Linked Transactions"
}
},
"required": [
"PCID",
"xero-tenant-id",
"LinkedTransactionID"
]
}
xero_payments_update_or_create_bank_transactions
Updates or creates one or more spent or received money transaction 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. |
BankTransactions | object[] | No | — | Bank Transactions |
pagination | object | No | — | The pagination value |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"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."
},
"BankTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"RECEIVE",
"RECEIVE-OVERPAYMENT",
"RECEIVE-PREPAYMENT",
"SPEND",
"SPEND-OVERPAYMENT",
"SPEND-PREPAYMENT",
"RECEIVE-TRANSFER",
"SPEND-TRANSFER"
],
"description": "See Bank Transaction 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 <Description> 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 <TaxAmount> 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 <TrackingCategory> 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"
},
"BankAccount": {
"type": "object",
"description": "Bank Account"
},
"IsReconciled": {
"type": "boolean",
"description": "Boolean to show if transaction is reconciled"
},
"Date": {
"type": "string",
"description": "Date of transaction – YYYY-MM-DD"
},
"Reference": {
"type": "string",
"description": "Reference for the transaction. Only supported for SPEND and RECEIVE transactions."
},
"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": "Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments."
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to App Name”"
},
"Status": {
"type": "string",
"enum": [
"AUTHORISED",
"DELETED",
"VOIDED"
],
"description": "See Bank Transaction 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"
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of bank transaction excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on bank transaction"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of bank transaction tax inclusive"
},
"BankTransactionID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for bank transaction"
},
"PrepaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT"
},
"OverpaymentID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "Boolean to indicate if a bank transaction has an attachment"
},
"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": [
"Type",
"LineItems",
"BankAccount"
]
},
"description": "Bank Transactions"
},
"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"
]
}