XExeroapi
Accounting

Updates a specific batch payment for invoices and credit notes

Changed on
post/BatchPayments

Request

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

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

BatchPaymentIDstring uuid required

The Xero generated unique identifier for the bank transaction (read-only)

Statusstring required

The status of the batch payment.

Response

Success - return response of type BatchPayments array for updated BatchPayment

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