API reference › Finance › Overview, clients and work items
Get finance settings by module
GET /v1/finance/settings
- Scope
finance:read- Roles
- admin, scheduler
Retrieves billing settings for finance modules (invoice, payables, payments, proforma). When module is omitted, returns all modules. Optional client_id scopes invoice and proforma to effective client–organization payment term and automation flags.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
module | string | Filter settings by module. Omit to return all modules. One of: |
client_id | string | When set, invoice and proforma modules include effective payment_terms and effective flags. For module=invoice, also returns slim admin_fee org defaults (method/amount only). Example |
provider_id | string | When set with module=payables, returns slim provider admin_fee defaults (method/amount only). Example |
is_org_invoice | boolean | When true with module=invoice, returns org-billed admin_fee defaults without client_id. Example |
workitem_ids | string | Comma-separated assignment/shift IDs (ASG-..., SHF-...). With module=invoice and client_id, returns admin_fee with organization + per-provider rows (fee_source calculated). Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/finance/settings" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Finance settings retrieved successfully
Finance settings retrieved successfully.
{
"success": true,
"message": "Finance settings retrieved successfully.",
"data": {
"payment_terms": {},
"notes": "Added by the scheduler.",
"summary": {
"tax_type": {},
"tax_amount": 10,
"discount_type": {},
"discount_amount": 0
},
"effective": {
"auto_generate": true,
"auto_send": true
}
}
}Response fields (13)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.payment_terms | object | Default payment terms { id, label } |
data.notes | string | Default notes Example |
data.summary | object | |
data.summary.tax_type | object | |
data.summary.tax_amount | number | Example |
data.summary.discount_type | object | |
data.summary.discount_amount | number | Example |
data.effective | object or null | |
data.effective.auto_generate | boolean | Example |
data.effective.auto_send | boolean | Example |
400 Bad request
Invalid module parameter
{
"success": false,
"message": "Invalid module. Must be one of: invoice, payables, payments, proforma."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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 |
404 Not found
Client not found (when client_id is provided)
{
"success": false,
"message": "Client not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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 |