GetPrepayments

Use this function to retrieve prepayments.

Properties

Authentication

Authentication values used to connect to the Xero server.

Prepayment id

You can retrieve an individual record by specifying the PrepaymentID.

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.

Where

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

Page

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

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.
  • he first item or an empty item.
  • ll the items one by one.
  • All of the items at once.


Output

Return type of Prepayments

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


Xero Developer: Prepayment (GET)