Use this function to retrieve overpayments.




Authentication values used to connect to the Xero server.

Overpayment id

You can retrieve an individual record by specifying the OverpaymentID.

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.


e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment.

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 Overpayments

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

Xero Developer: Overpayments (GET)