API reference › Rates and billing › Reimbursable expenses

List reimbursable expenses

GET /v1/settings/reimbursable-expenses

Scope
settings_rates_billing:read finance:read
Roles
admin, scheduler

Retrieves a paginated list of reimbursable expenses with optional filters. Finances data: without Finance Read it answers 200 with an empty page (data [], meta.total 0) and the reason in message, whatever the role holds on Rates & Billing.

Parameters

Query parameters

NameTypeDescription
searchstring

Search term to filter expenses by name or other attributes

Example Expense 1.

startDatestring (date)

Start date for filtering expenses (format: YYYY-MM-DD)

Example 2023-01-01.

endDatestring (date)

End date for filtering expenses (format: YYYY-MM-DD)

Example 2023-12-31.

sortBystring

Field to sort the results by (e.g., 'name', 'created_at')

Example name.

sortOrderstring

Sort order for the results (e.g., 'asc', 'desc')

Example asc.

perPageinteger

Number of items per page for pagination

Example 10.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/reimbursable-expenses" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 List of reimbursable expenses retrieved successfully

List of reimbursable expenses retrieved successfully.

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Example name",
      "enabled": true,
      "expenseType": {
        "id": "string",
        "label": "Example label"
      },
      "reimbursementBasis": {
        "id": "string",
        "label": "Example label"
      },
      "rate": 0,
      "unit": {
        "id": "string",
        "label": "Example label"
      },
      "proofRequired": true,
      "contractorEligible": true,
      "networkEligible": true,
      "employedEligible": true,
      "appliedToAssignment": true,
      "appliedToShift": true,
      "travelRadius": "string",
      "autoApprovalThreshold": 0,
      "billTo": "string",
      "visibleToProvider": true,
      "visibleToClient": true,
      "expenseCategoryNotes": "Added by the scheduler.",
      "maximumReimbursementCap": "string"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 2
  }
}
Response fields (33)

3 top-level fields; 2 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

dataarray of object (26 nested)
metaobject (4 nested)

Nested fields

data 26 fields
FieldTypeDescription
data[].idinteger

Example 1.

data[].namestring

Example Example name.

data[].enabledboolean

Example true.

data[].expenseTypeobject
data[].expenseType.idstring

Example string.

data[].expenseType.labelstring

Example Example label.

data[].reimbursementBasisobject
data[].reimbursementBasis.idstring

Example string.

data[].reimbursementBasis.labelstring

Example Example label.

data[].rateinteger

Example 0.

data[].unitobject
data[].unit.idstring

Example string.

data[].unit.labelstring

Example Example label.

data[].proofRequiredboolean

Example true.

data[].contractorEligibleboolean

Example true.

data[].networkEligibleboolean

Example true.

data[].employedEligibleboolean

Example true.

data[].appliedToAssignmentboolean

Example true.

data[].appliedToShiftboolean

Example true.

data[].travelRadiusstring

Example string.

data[].autoApprovalThresholdinteger

Example 0.

data[].billTostring

Example string.

data[].visibleToProviderboolean

Example true.

data[].visibleToClientboolean

Example true.

data[].expenseCategoryNotesstring

Example Added by the scheduler..

data[].maximumReimbursementCapstring

Example string.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 2.

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

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 'settings_rates_billing: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 'settings_rates_billing: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

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