Get Payments

Retrieves payments for invoices and credit notes

GET/Payments

Use it in a workflow

Add a step and choose the Xero connector.
Pick the Get Payments action (under Xero).
Fill in the fields below, then reference the result from later steps as {{getPayments.response.data}}.

Request

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

xero-tenant-idstringrequired

Xero identifier for Tenant

If-Modified-Sincestring (date-time)

Only records created or modified since this timestamp will be returned

Response

Returns 200 with an object. Read it in later steps with {{getPayments.response.data.<field>}}.

paginationobject

pageinteger

pageSizeinteger

pageCountinteger

itemCountinteger

Warningsarray<object>

Displays array of warning messages from the API

Messagestring

Validation error message

Paymentsarray<object>

Invoiceobject

Circular reference: #/components/schemas/Invoice

CreditNoteobject

Circular reference: #/components/schemas/CreditNote

Prepaymentobject23 fields

Overpaymentobject21 fields

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

BatchPaymentobject17 fields

Accountobject20 fields

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

Statusstring

The status of the payment.

One ofAUTHORISEDDELETED

PaymentTypestring

See Payment Types.

One ofACCRECPAYMENTACCPAYPAYMENTARCREDITPAYMENTAPCREDITPAYMENTAROVERPAYMENTPAYMENTARPREPAYMENTPAYMENTAPPREPAYMENTPAYMENTAPOVERPAYMENTPAYMENT

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

Default "false"

HasValidationErrorsboolean

A boolean to indicate if a contact has an validation errors

Default "false"

StatusAttributeStringstring

A string to indicate if a invoice status

ValidationErrorsarray<object>1 fields

Displays array of validation error messages from the API

Warningsarray<object>1 fields

Displays array of warning messages from the API

json

{
  "pagination": {
    "page": 0,
    "pageSize": 0,
    "pageCount": 0,
    "itemCount": 0
  },
  "Warnings": [
    {
      "Message": "string"
    }
  ],
  "Payments": [
    {
      "Invoice": {},
      "CreditNote": {},
      "Prepayment": {
        "Type": {},
        "Contact": {},
        "Date": {},
        "Status": {},
        "LineAmountTypes": {},
        "LineItems": {},
        "SubTotal": {},
        "TotalTax": {},
        "Total": {},
        "Reference": {},
        "InvoiceNumber": {},
        "UpdatedDateUTC": {}
      },
      "Overpayment": {
        "Type": {},
        "Contact": {},
        "Date": {},
        "Status": {},
        "LineAmountTypes": {},
        "LineItems": {},
        "SubTotal": {},
        "TotalTax": {},
        "Total": {},
        "UpdatedDateUTC": {},
        "UpdatedDateUTCString": {},
        "CurrencyCode": {}
      },
      "InvoiceNumber": "string",
      "CreditNoteNumber": "string",
      "BatchPayment": {
        "Account": {},
        "Reference": {},
        "Particulars": {},
        "Code": {},
        "Details": {},
        "Narrative": {},
        "BatchPaymentID": {},
        "DateString": {},
        "Date": {},
        "Amount": {},
        "Payments": {},
        "Type": {}
      },
      "Account": {
        "Code": 4400,
        "Name": "Food Sales",
        "AccountID": "00000000-0000-0000-0000-000000000000",
        "Type": "BANK",
        "BankAccountNumber": "string",
        "Status": "ACTIVE",
        "Description": "string",
        "BankAccountType": "BANK",
        "CurrencyCode": "AED",
        "TaxType": "string",
        "EnablePaymentsToAccount": false,
        "ShowInExpenseClaims": false
      },
      "Code": "string",
      "Date": "string",
      "CurrencyRate": 0,
      "Amount": 0
    }
  ]
}

Need more? See the Xero guide for connection setup and behaviour shared by every action.

Was this page helpful?