Use this method to retrieve either one or many payments for invoices and credit notes.



Authentication values used to connect to the Xero server.

Payment id

You can retrieve an individual record by specifying the PaymentID.

Modified after

A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only records created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00.


Restrict the returned items using the specified criteria. See Where filter.

Order by

Return items in a specific order. See Order by filter.

Return options

Select how the data is to be returned.

Possible values are:

  • Only the first item.
  • The first item or an empty item.
  • All the items one by one.
  • All of the items at once.


Return type of Payments

A list of payments or a single payment depending on the selected Return option (see above).

Xero Developer: Payments (GET)