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.

FieldTypeDescription
name requiredstring

Unique in the catalog.

max length 255. Example Mileage.

enabledboolean or null

Defaults to true.

Example true.

expenseType requiredstring

One of: travel, lodging, meals, supplies, miscellaneous. Example travel.

reimbursementBasic requiredstring

How the rate is applied.

One of: per_unit, per_day, flat_amount, percentage. Example per_unit.

rate requirednumber

Example 0.67.

unitobject (2 nested)

Unit the rate is per, such as mile.

billTo requiredstring

client and organization are accepted as aliases. Defaults to the organization's billing setting when that is set.

One of: bill_to_client, organization_pays, client, organization. Example bill_to_client.

proofRequiredboolean or null

Providers must attach a receipt.

appliedToAssignmentboolean or null
appliedToShiftboolean or null
contractorEligibleboolean or null
networkEligibleboolean or null
employedEligibleboolean or null
visibleToProviderboolean or null
visibleToClientboolean or null
travelRadiusarray of object or null (2 nested)
autoApprovalThresholdnumber or null

Amounts up to this approve automatically. Defaults to 0.

Example 25.

expenseCategoryNotesstring or null

max length 2000.

maximumReimbursementCapnumber or null

Example 150.

Nested fields

unit 2 fields
FieldTypeDescription
unit.idinteger or string

Example 1.

unit.labelstring or null

Example Example.

travelRadius 2 fields
FieldTypeDescription
travelRadius[].idinteger or string

Example 1.

travelRadius[].labelstring or null

Example Example.

Example

JSON
{
  "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

Shell
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.

JSON
{
  "success": true,
  "message": "Expense has been saved successfully.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Expense has been saved successfully..

datastring or null
401 Not signed in

Unauthorized - Authentication required

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

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.

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

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_rates_billing:write' 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

Internal server error

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

Example false.

messagestring

Example An unexpected error occurred. Please try again later..