API reference › Rates and billing › Reimbursable expenses
Create reimbursable expense
POST /v1/settings/reimbursable-expenses
- Scope
settings_rates_billing:write finance:write- Roles
- admin, scheduler
Creates a new reimbursable expense with the specified details.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
19 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name required | string | Unique in the catalog. max length 255. Example |
enabled | boolean or null | Defaults to true. Example |
expenseType required | string | One of: |
reimbursementBasic required | string | How the rate is applied. One of: |
rate required | number | Example |
unit | object (2 nested) | Unit the rate is per, such as mile. |
billTo required | string | client and organization are accepted as aliases. Defaults to the organization's billing setting when that is set. One of: |
proofRequired | boolean or null | Providers must attach a receipt. |
appliedToAssignment | boolean or null | |
appliedToShift | boolean or null | |
contractorEligible | boolean or null | |
networkEligible | boolean or null | |
employedEligible | boolean or null | |
visibleToProvider | boolean or null | |
visibleToClient | boolean or null | |
travelRadius | array of object or null (2 nested) | |
autoApprovalThreshold | number or null | Amounts up to this approve automatically. Defaults to 0. Example |
expenseCategoryNotes | string or null | max length 2000. |
maximumReimbursementCap | number or null | Example |
Nested fields
unit 2 fields
| Field | Type | Description |
|---|---|---|
unit.id | integer or string | Example |
unit.label | string or null | Example |
travelRadius 2 fields
| Field | Type | Description |
|---|---|---|
travelRadius[].id | integer or string | Example |
travelRadius[].label | string or null | Example |
Example
{
"name": "Mileage",
"enabled": true,
"expenseType": "travel",
"reimbursementBasic": "per_unit",
"rate": 0.67,
"unit": {
"id": 1,
"label": "Example"
},
"billTo": "bill_to_client",
"proofRequired": true,
"appliedToAssignment": true,
"appliedToShift": true,
"contractorEligible": true,
"networkEligible": true,
"employedEligible": true,
"visibleToProvider": true,
"visibleToClient": true,
"travelRadius": [
{
"id": 1,
"label": "Example"
}
],
"autoApprovalThreshold": 25,
"expenseCategoryNotes": "string",
"maximumReimbursementCap": 150
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/reimbursable-expenses" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Mileage","enabled":true,"expenseType":"travel","reimbursementBasic":"per_unit","rate":0.67,"unit":{"id":1,"label":"Example"},"billTo":"bill_to_client","proofRequired":true,"appliedToAssignment":true,"appliedToShift":true,"contractorEligible":true,"networkEligible":true,"employedEligible":true,"visibleToProvider":true,"visibleToClient":true,"travelRadius":[{"id":1,"label":"Example"}],"autoApprovalThreshold":25,"expenseCategoryNotes":"string","maximumReimbursementCap":150}'Try it
Responses
200 Reimbursable expense have been updated
Reimbursable expense have been updated.
{
"success": true,
"message": "Expense has been saved successfully.",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | string or null |
401 Not signed in
Unauthorized - Authentication required
{
"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
Forbidden. These mappings are Finances data, so a role without Finance Read is refused whatever it holds on Rates & Billing; with it, the Rates & Billing level the change needs decides.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_rates_billing:write' 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
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |