Create Payment History

Creates a history record for a specific payment

PUT/Payments/{PaymentID}/History

Use it in a workflow

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

Request

Path parameters

PaymentIDstring (uuid)required

Unique identifier for a Payment

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.

Response

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

HistoryRecordsarray<object>

Detailsstring

details

Changesstring

Name of branding theme

Userstring

has a value of 0

DateUTCstring

UTC timestamp of creation date of branding theme

json

{
  "HistoryRecords": [
    {
      "Details": "string",
      "Changes": "string",
      "User": "string",
      "DateUTC": "/Date(1573755038314)/"
    }
  ]
}

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

Was this page helpful?