Accounting

Retrieves overpayments

get/Overpayments

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

pageinteger

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

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

Referencesstring[]

Filter by a comma-separated list of References

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Success - return response of type Overpayments array with all Overpayments

Changed in 5 of the 61 revisions of this API.8

Jul 13, 202657750919b9571See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jan 16, 2026e742d918b2482See the full diff
- ○
  added the new optional query request parameter References
  new-optional-request-parameter
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Sep 15, 2025ab9dba3c87461See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Sep 16, 20243aad5a420f763See 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
Jul 29, 202498ef773227e51See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added