XExeroapi
Accounting

Creates a single payment for invoice or credit notes

Changed on
post/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

Headers

Idempotency-Keystring

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

Request body

InvoiceNumberstring

Number of invoice or credit note you are applying payment to e.g.INV-4003

CreditNoteNumberstring

Number of invoice or credit note you are applying payment to e.g. INV-4003

Codestring

Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)

Datestring

Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06

CurrencyRatenumber double

Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500

Amountnumber double

The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00

BankAmountnumber double

The amount of the payment in the currency of the bank account.

Referencestring

An optional description for the payment e.g. Direct Debit

IsReconciledboolean

An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET

Status'AUTHORISED' | 'DELETED'

The status of the payment.

PaymentType'ACCRECPAYMENT' | 'ACCPAYPAYMENT' | 'ARCREDITPAYMENT' | 'APCREDITPAYMENT' | 'AROVERPAYMENTPAYMENT' | 'ARPREPAYMENTPAYMENT' | 'APPREPAYMENTPAYMENT' | 'APOVERPAYMENTPAYMENT'

See Payment Types.

UpdatedDateUTCstring

UTC timestamp of last update to the payment

UpdatedDateUTCStringstring

UTC ISO-8601 formatted timestamp of last update to the payment

PaymentIDstring uuid

The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

BatchPaymentIDstring uuid

Present if the payment was created as part of a batch.

BankAccountNumberstring

The suppliers bank account number the payment is being made to

Particularsstring

The suppliers bank account number the payment is being made to

Detailsstring

The information to appear on the supplier's bank account

HasAccountboolean

A boolean to indicate if a contact has an validation errors

HasValidationErrorsboolean

A boolean to indicate if a contact has an validation errors

StatusAttributeStringstring

A string to indicate if a invoice status

Response

Success - return response of type Payments array for newly created Payment

Changes

  • de95a0883a4aRevision changes
    • info

      the request optional property / became not read-only

    • info

      the request optional property /// became not read-only

    • info

      the request optional property ////// became not read-only

    • info

      the request optional property //// became not read-only

    • 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 new optional request property /

    • info

      added the new optional request property /

    • info

      the request optional property / became not read-only

    • info

      the request optional property / became not read-only

    • info

      the request optional property / became not read-only

    • 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