Invoke Skill Reports Forecast Prepare
post
/api/v1/skills/reports.forecast.prepare/invokePrepare a financial forecast β multi-scenario, with assumptions register.
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
client_idrequired | string (uuid) | β |
horizon_months | integer | β |
scenarios | "base" | "optimistic" | "pessimistic"[] | β |
projection_type | "pnl" | "cashflow" | "balance_sheet"[] | β |
seasonal_adjustment | boolean | β |
growth_assumptions | object | βshow nestedEmpty object. |
output_format | "data" | "document" | "both" | βdatadocumentboth |
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.forecast.prepare/invoke \
-X POST \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"client_id": "00000000-0000-0000-0000-000000000000",
"horizon_months": 0,
"scenarios": [
"base"
],
"projection_type": [
"pnl"
],
"seasonal_adjustment": false,
"growth_assumptions": {},
"output_format": "data"
}'