XExeroapi
Accounting

Retrieves payments for invoices and credit notes

Changed on
get/Payments

Request

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

Up to 100 payments will be returned in a single API call

pageSizeinteger

Number of records to retrieve per page

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of type Payments array for all Payments

Changes

  • de95a0883a4aRevision changes
    • info

      the response optional property /// became not read-only for the status

    • info

      the response optional property ///// became not read-only for the status

    • info

      the response optional property //////// became not read-only for the status

    • info

      the response optional property ////// became not read-only for the status

  • a6564fbc9cd6Revision changes
    • info

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

    • info

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

    • info

      the response optional property /// became not read-only for the status

    • info

      the response optional property /// became not read-only for the status

    • info

      the response optional property /// became not read-only for the status