Invoke Skill Reports Tax Return Prepare
post
/api/v1/skills/reports.tax-return.prepare/invokePrepare a tax return artifact β income, BAS, IAS, VAT, corporate tax, payroll, or self-assessment.
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
client_idrequired | string (uuid) | β |
jurisdictionrequired | "AU" | "GB" | "CA" | "US" | "NZ" | βAUGBCAUSNZ |
entity_type | "individual" | "company" | "partnership" | "trust" | βindividualcompanypartnershiptrust |
return_type | "income" | "bas" | "ias" | "vat" | "corp" | "payroll" | "self_assessment" | βincomebasiasvatcorppayrollself_assessment |
tax_yearrequired | string | β |
file_ids | string (uuid)[] | β |
Responses
200Skill executed successfully
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
skillrequired | string | β | |||||||||||||||||||||||||||||||||||||||
outputrequired | object | βshow nested
| |||||||||||||||||||||||||||||||||||||||
correlation_idrequired | string | β |
401Authentication required
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
403Insufficient permissions
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
404Skill not found
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
429Rate limit exceeded
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
5XXInternal server error
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
curl https://api.dev.arch.ie/api/v1/skills/reports.tax-return.prepare/invoke \
-X POST \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"client_id": "00000000-0000-0000-0000-000000000000",
"jurisdiction": "AU",
"entity_type": "individual",
"return_type": "income",
"tax_year": "string",
"file_ids": [
"00000000-0000-0000-0000-000000000000"
]
}'