Accounting

Retrieves a specific overpayment using a unique overpayment Id

Changed on
get/Overpayments/{OverpaymentID}

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}
  • 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

Path parameters

OverpaymentIDstring uuid required

Unique identifier for a Overpayment

Response

Success - return response of type Overpayments array with specified Overpayments

Changes

    • info

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

    • info

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