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

NameTypeDescription
typestring

Filter statuses by module type

One of: invoice, proforma, payable, payment_statement. Example invoice.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Financial statuses retrieved successfully..

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Backend status name (always returned)

Example Sent.

data[].labelstring

Role-based display label: portal_display_label for client/provider, name for admin/scheduler

Example New.

data[].typestring

Example invoice.

data[].codestring

Example INVOICE_SENT.

data[].portal_display_labelstring or null

Portal display label (null for admin-only statuses)

Example New.

data[].portal_visibleboolean

Whether status is visible in portal for client/provider

Example true.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'finance:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Unexpected error

JSON
{
  "success": false,
  "message": "An unexpected error occurred."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred..