Accounting

Retrieves prepayments

get/Prepayments

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

pageinteger

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

unitdpinteger

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

pageSizeinteger

Number of records to retrieve per page

InvoiceNumbersstring[]

Filter by a comma-separated list of InvoiceNumbers

Referencesstring[]

Filter by a comma-separated list of References

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of type Prepayments array for all Prepayment

Changes

Changed in 9 of the 61 revisions of this API.23

Sep 3, 2026de95a0883a4a1See the full diff
- ○
  the response optional property ///// became not read-only for the status
  response-optional-property-became-not-read-only
Jul 21, 2026dc231cafd8de1See the full diff
- ○
  added the new optional query request parameter References
  new-optional-request-parameter
Jul 13, 202657750919b9573See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Apr 23, 2026174f063d0d551See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Mar 26, 2026f96650a7d52e2See the full diff
- ○
  added the new optional query request parameter InvoiceNumbers
  new-optional-request-parameter
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jan 16, 2026e742d918b2481See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Sep 15, 2025ab9dba3c87463See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Sep 16, 20243aad5a420f7610See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Jul 29, 202498ef773227e51See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history