XExeroapi
Accounting

Retrieves overpayments

Changed on
get/Overpayments

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/Overpayments
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.transactions, accounting.transactions.read

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

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of type Overpayments array with all Overpayments

Changes

  • 57750919b957Revision changes
    • info

      added the optional property // to the response with the status

  • e742d918b248Revision changes
    • info

      added the new optional query request parameter References

    • info

      added the optional property // to the response with the status