xero.linked-transactions.create-linked-transaction

Creates linked transactions (billable expenses)

Overview

Property	Value
Workflow type	Atomic
Library	App-xero
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Xero API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
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.
sourcetransactionid	string	No	—	Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
sourcelineitemid	string	No	—	The line item identifier from the source transaction.
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.
targettransactionid	string	No	—	Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
targetlineitemid	string	No	—	The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID.
linkedtransactionid	string	No	—	The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9
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.
type	string	No	—	This will always be BILLABLEEXPENSE. More types may be added in future.
updateddateutc	string	No	—	The last modified date in UTC format
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.
validationerrors	list	No	—	Displays array of validation error messages from the API

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Xero API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
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.
sourcetransactionid	string	No	—	Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
sourcelineitemid	string	No	—	The line item identifier from the source transaction.
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.
targettransactionid	string	No	—	Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
targetlineitemid	string	No	—	The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID.
linkedtransactionid	string	No	—	The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9
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.
type	string	No	—	This will always be BILLABLEEXPENSE. More types may be added in future.
updateddateutc	string	No	—	The last modified date in UTC format
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.
validationerrors	list	No	—	Displays array of validation error messages from the API
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /LinkedTransactions
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /LinkedTransactions
* (any state)	fail	failed	Record the failure reason

Outcomes

Outcome	Type	Description	State Data Keys
completed	SUCCESS	The provider accepted the request	status_code, response
failed	FAILURE	The provider rejected the request or was unreachable	failure_reason, failure_type, status_code

Business Errors

Code	Message Template
HTTP_AUTHENTICATION_FAILED	The provider rejected the credential (HTTP {status_code})
HTTP_AUTHORIZATION_FAILED	The credential is not permitted to perform this operation (HTTP {status_code})
HTTP_NOT_FOUND	The provider has no resource at {path} (HTTP 404)
HTTP_RATE_LIMITED	The provider rate-limited this request (HTTP 429)
HTTP_REQUEST_FAILED	The provider returned HTTP {status_code} for {method}
HTTP_RESPONSE_SHAPE_UNEXPECTED	The provider response for {method} {path} could not be parsed as JSON

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "xero.linked-transactions.create-linked-transaction",
  "initial_data": {
    "base_url": "value",
    "xero_tenant_id": "value"
  }
}