API reference › Finance › Overview, clients and work items
Get all financial statuses
GET /v1/finance/financial-statuses
- Scope
finance:read- Roles
- admin, scheduler
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
type | string | Filter statuses by module type One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/financial-statuses" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Financial statuses retrieved successfully
Financial statuses retrieved successfully
{
"success": true,
"message": "Financial statuses retrieved successfully.",
"data": [
{
"id": 1,
"name": "Sent",
"label": "New",
"type": "invoice",
"code": "INVOICE_SENT",
"portal_display_label": "New",
"portal_visible": true
}
]
}Response fields (10)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Backend status name (always returned) Example |
data[].label | string | Role-based display label: portal_display_label for client/provider, name for admin/scheduler Example |
data[].type | string | Example |
data[].code | string | Example |
data[].portal_display_label | string or null | Portal display label (null for admin-only statuses) Example |
data[].portal_visible | boolean | Whether status is visible in portal for client/provider Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'finance:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Unexpected error
{
"success": false,
"message": "An unexpected error occurred."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |