Create Payment

Creates a single payment for invoice or credit notes

POST/Payments

Use it in a workflow

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

Request

Headers

xero-tenant-idstringrequired

Xero identifier for Tenant

Idempotency-Keystring

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

Request body

Enter the body as JSON in the step's Body field.

Invoiceobject

Circular reference: #/components/schemas/Invoice

CreditNoteobject

Circular reference: #/components/schemas/CreditNote

Prepaymentobject

Typeobject

(schema truncated: exceeded maximum nesting depth)

Contactobject

(schema truncated: exceeded maximum nesting depth)

Dateobject

(schema truncated: exceeded maximum nesting depth)

Statusobject

(schema truncated: exceeded maximum nesting depth)

LineAmountTypesobject

(schema truncated: exceeded maximum nesting depth)

LineItemsobject

(schema truncated: exceeded maximum nesting depth)

SubTotalobject

(schema truncated: exceeded maximum nesting depth)

TotalTaxobject

(schema truncated: exceeded maximum nesting depth)

Totalobject

(schema truncated: exceeded maximum nesting depth)

Referenceobject

(schema truncated: exceeded maximum nesting depth)

InvoiceNumberobject

(schema truncated: exceeded maximum nesting depth)

UpdatedDateUTCobject

(schema truncated: exceeded maximum nesting depth)

UpdatedDateUTCStringobject

(schema truncated: exceeded maximum nesting depth)

CurrencyCodeobject

(schema truncated: exceeded maximum nesting depth)

PrepaymentIDobject

(schema truncated: exceeded maximum nesting depth)

BrandingThemeIDobject

(schema truncated: exceeded maximum nesting depth)

CurrencyRateobject

(schema truncated: exceeded maximum nesting depth)

RemainingCreditobject

(schema truncated: exceeded maximum nesting depth)

Allocationsobject

(schema truncated: exceeded maximum nesting depth)

Paymentsobject

(schema truncated: exceeded maximum nesting depth)

AppliedAmountobject

(schema truncated: exceeded maximum nesting depth)

HasAttachmentsobject

(schema truncated: exceeded maximum nesting depth)

Attachmentsobject

(schema truncated: exceeded maximum nesting depth)

Overpaymentobject

Typeobject

(schema truncated: exceeded maximum nesting depth)

Contactobject

(schema truncated: exceeded maximum nesting depth)

Dateobject

(schema truncated: exceeded maximum nesting depth)

Statusobject

(schema truncated: exceeded maximum nesting depth)

LineAmountTypesobject

(schema truncated: exceeded maximum nesting depth)

LineItemsobject

(schema truncated: exceeded maximum nesting depth)

SubTotalobject

(schema truncated: exceeded maximum nesting depth)

TotalTaxobject

(schema truncated: exceeded maximum nesting depth)

Totalobject

(schema truncated: exceeded maximum nesting depth)

UpdatedDateUTCobject

(schema truncated: exceeded maximum nesting depth)

UpdatedDateUTCStringobject

(schema truncated: exceeded maximum nesting depth)

CurrencyCodeobject

(schema truncated: exceeded maximum nesting depth)

OverpaymentIDobject

(schema truncated: exceeded maximum nesting depth)

CurrencyRateobject

(schema truncated: exceeded maximum nesting depth)

RemainingCreditobject

(schema truncated: exceeded maximum nesting depth)

Allocationsobject

(schema truncated: exceeded maximum nesting depth)

AppliedAmountobject

(schema truncated: exceeded maximum nesting depth)

Paymentsobject

(schema truncated: exceeded maximum nesting depth)

HasAttachmentsobject

(schema truncated: exceeded maximum nesting depth)

Referenceobject

(schema truncated: exceeded maximum nesting depth)

Attachmentsobject

(schema truncated: exceeded maximum nesting depth)

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

BatchPaymentobject

Accountobject

(schema truncated: exceeded maximum nesting depth)

Referenceobject

(schema truncated: exceeded maximum nesting depth)

Particularsobject

(schema truncated: exceeded maximum nesting depth)

Codeobject

(schema truncated: exceeded maximum nesting depth)

Detailsobject

(schema truncated: exceeded maximum nesting depth)

Narrativeobject

(schema truncated: exceeded maximum nesting depth)

BatchPaymentIDobject

(schema truncated: exceeded maximum nesting depth)

DateStringobject

(schema truncated: exceeded maximum nesting depth)

Dateobject

(schema truncated: exceeded maximum nesting depth)

Amountobject

(schema truncated: exceeded maximum nesting depth)

Paymentsobject

(schema truncated: exceeded maximum nesting depth)

Typeobject

(schema truncated: exceeded maximum nesting depth)

Statusobject

(schema truncated: exceeded maximum nesting depth)

TotalAmountobject

(schema truncated: exceeded maximum nesting depth)

UpdatedDateUTCobject

(schema truncated: exceeded maximum nesting depth)

IsReconciledobject

(schema truncated: exceeded maximum nesting depth)

ValidationErrorsobject

(schema truncated: exceeded maximum nesting depth)

Accountobject

Codestring

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)

Namestring

Name of account (max length = 150)

AccountIDstring (uuid)

The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

Typestring

See Account Types

One ofBANKCURRENTCURRLIABDEPRECIATNDIRECTCOSTSEQUITYEXPENSEFIXEDINVENTORYLIABILITYNONCURRENTOTHERINCOMEOVERHEADSPREPAYMENTREVENUESALESTERMLIABPAYG

BankAccountNumberstring

For bank accounts only (Account Type BANK)

Statusstring

Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes

One ofACTIVEARCHIVEDDELETED

Descriptionstring

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)

BankAccountTypestring

For bank accounts only. See Bank Account types

One ofBANKCREDITCARDPAYPALNONE

CurrencyCodestring

3 letter alpha code for the currency – see list of currency codes

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBYRBZDCADCDFCHFCLFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

TaxTypestring

The tax type from taxRates

EnablePaymentsToAccountboolean

Boolean – describes whether account can have payments applied to it

ShowInExpenseClaimsboolean

Boolean – describes whether account code is available for use with expense claims

Classstring

See Account Class Types

One ofASSETEQUITYEXPENSELIABILITYREVENUE

SystemAccountstring

If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.

One ofDEBTORSCREDITORSBANKCURRENCYGAINGSTGSTONIMPORTSHISTORICALREALISEDCURRENCYGAINRETAINEDEARNINGSROUNDINGTRACKINGTRANSFERSUNPAIDEXPCLMUNREALISEDCURRENCYGAINWAGEPAYABLESCISASSETSCISASSETCISLABOURCISLABOUREXPENSECISLABOURINCOMECISLIABILITYCISMATERIALS

ReportingCodestring

Shown if set

ReportingCodeNamestring

Shown if set

HasAttachmentsboolean

boolean to indicate if an account has an attachment (read only)

Default "false"

UpdatedDateUTCstring

Last modified date UTC format

AddToWatchlistboolean

Boolean – describes whether the account is shown in the watchlist widget on the dashboard

ValidationErrorsarray<object>1 fields

Displays array of validation error messages from the API

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>

Displays array of validation error messages from the API

Messagestring

Validation error message

Warningsarray<object>

Displays array of warning messages from the API

Messagestring

Validation error message

json

{
  "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
}

Response

Returns 200 with an object. Read it in later steps with {{createPayment.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?