GET /LinkedTransactions

Servers

Request headers

Name Type Required Description
xero-tenant-id String Yes

Xero identifier for Tenant

Query parameters

Name Type Required Description
page Integer No

Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.

ContactID String No

Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.

SourceTransactionID String No

Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice

Status String No

Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status

TargetTransactionID String No

Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

LinkedTransactionID String No

The Xero identifier for an Linked Transaction

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.