Invoke Skill Clients Financials Get
post
/api/v1/skills/clients.financials.get/invokeGet client financial data (raw, summary, variance, cashflow, or profitability view).
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
client_idrequired | string (uuid) | — |
view | "raw" | "summary" | "variance" | "cashflow" | "profitability" | —rawsummaryvariancecashflowprofitability |
period | string | null | — |
compare_period | string | null | — |
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/clients.financials.get/invoke \
-X POST \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"client_id": "00000000-0000-0000-0000-000000000000",
"view": "raw",
"period": null,
"compare_period": null
}'