Xero: Retrieves payments for invoices and credit notes

← Accounting operations · Get started

Operation xero.getpayments

Provider route: GET /api.xro/2.0/Payments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["accounting"]["getPayments"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.accounting.getPayments(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.accounting.get_payments(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.where	string	Optional
query.order	string	Optional
query.page	integer	Optional
query.pageSize	integer	Optional
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent
headers.If-Modified-Since	string	Optional	Format: date-time

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieves payments for invoices and credit notes — response body

Referenced models: Retrieves payments for invoices and credit notes — response body

Schemas

23 more schemas are linked from the tables above, on the schema pages.

Retrieves payments for invoices and credit notes — response body

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

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

Retrieves prepayments — response body — pagination

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

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

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

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

Retrieves journals — response body — Warnings item

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

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

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

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

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

Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item

Field	Type	Presence	Description and constraints
$	object	Root
TrackingCategoryName	string	Optional	The default sales tracking category name for contacts
TrackingOptionName	string	Optional	The default purchase tracking category name for contacts

Policy, approvals and errors

SDK function policy ID: xero.getpayments. Catalog operation: getPayments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source