POST /LinkedTransactions/{LinkedTransactionID}
Servers
- https://api.xero.com/api.xro/2.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
LinkedTransactionID |
String | Yes |
Unique identifier for a LinkedTransaction |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Idempotency-Key |
String | No |
This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
LinkedTransactions[] |
Array | No | |
LinkedTransactions[].ContactID |
String | No |
Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. |
LinkedTransactions[].SourceTransactionTypeCode |
String | No |
The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction. Possible values:
|
LinkedTransactions[].SourceTransactionID |
String | No |
Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice |
LinkedTransactions[].TargetLineItemID |
String | No |
The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. |
LinkedTransactions[].Status |
String | No |
Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. Possible values:
|
LinkedTransactions[].TargetTransactionID |
String | No |
Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice |
LinkedTransactions[].Type |
String | No |
This will always be BILLABLEEXPENSE. More types may be added in future. Possible values:
|
LinkedTransactions[].ValidationErrors[] |
Array | No |
Displays array of validation error messages from the API |
LinkedTransactions[].ValidationErrors[].Message |
String | No |
Validation error message |
LinkedTransactions[].SourceLineItemID |
String | No |
The line item identifier from the source transaction. |
LinkedTransactions[].LinkedTransactionID |
String | No |
The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
LinkedTransactions[].UpdatedDateUTC |
String | No |
The last modified date in UTC format |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.