API reference › Rates and billing › Provider rates

Create provider rates

POST /v1/settings/provider-rates

Scope
settings_rates_billing:write finance:write
Roles
admin, scheduler

Creates provider rates by expanding multi-select fields into individual rows. Same expansion logic as service type rates, plus providerRoles as a free combination field. Duplicates are detected by all fields except rate and minimumDuration.

Parameters

None of its own.

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

Request body required

12 top-level fields; 7 hold nested fields, listed below.

FieldTypeDescription
serviceType requiredarray of object (2 nested)

Multi-select service types

serviceProviderType requiredarray of object (2 nested)

Multi-select provider types

certificationarray of object or null (2 nested)

Multi-select certifications

rateType requiredarray of object (2 nested)

Multi-select rate types

siteType requiredarray of object (2 nested)

Multi-select site types

specializationarray of object or null (2 nested)

Multi-select specializations

providerRolearray of object or null (2 nested)

Multi-select provider roles

unit requiredstring

Example hr.

rate requirednumber

Example 3.

minimumDurationinteger or null

Example 34.

assignmentboolean

Example true.

shiftboolean

Example false.

Nested fields

serviceType 2 fields
FieldTypeDescription
serviceType[].idinteger

Example 1.

serviceType[].labelstring

Example ASL.

serviceProviderType 2 fields
FieldTypeDescription
serviceProviderType[].idinteger

Example 2.

serviceProviderType[].labelstring

Example Hearing Interpreter.

certification 2 fields
FieldTypeDescription
certification[].idinteger

Example 1.

certification[].labelstring

Example NIC.

rateType 2 fields
FieldTypeDescription
rateType[].idinteger

Example 3.

rateType[].labelstring

Example Emergency.

siteType 2 fields
FieldTypeDescription
siteType[].idstring

Example onsite_client.

siteType[].labelstring

Example On-Site (Client).

specialization 2 fields
FieldTypeDescription
specialization[].idinteger

Example 1.

specialization[].labelstring

Example Legal.

providerRole 2 fields
FieldTypeDescription
providerRole[].idstring

Example agency.

providerRole[].labelstring

Example Agency.

Example

JSON
{
  "serviceType": [
    {
      "id": 1,
      "label": "ASL"
    }
  ],
  "serviceProviderType": [
    {
      "id": 2,
      "label": "Hearing Interpreter"
    }
  ],
  "certification": [
    {
      "id": 1,
      "label": "NIC"
    }
  ],
  "rateType": [
    {
      "id": 3,
      "label": "Emergency"
    }
  ],
  "siteType": [
    {
      "id": "onsite_client",
      "label": "On-Site (Client)"
    }
  ],
  "specialization": [
    {
      "id": 1,
      "label": "Legal"
    }
  ],
  "providerRole": [
    {
      "id": "agency",
      "label": "Agency"
    }
  ],
  "unit": "hr",
  "rate": 3,
  "minimumDuration": 34,
  "assignment": true,
  "shift": false
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/provider-rates" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"serviceType":[{"id":1,"label":"ASL"}],"serviceProviderType":[{"id":2,"label":"Hearing Interpreter"}],"certification":[{"id":1,"label":"NIC"}],"rateType":[{"id":3,"label":"Emergency"}],"siteType":[{"id":"onsite_client","label":"On-Site (Client)"}],"specialization":[{"id":1,"label":"Legal"}],"providerRole":[{"id":"agency","label":"Agency"}],"unit":"hr","rate":3,"minimumDuration":34,"assignment":true,"shift":false}'

Try it

Responses

201 Provider rates created successfully

Provider rates created successfully.

JSON
{
  "success": true,
  "message": "12 provider rate(s) saved successfully.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example 12 provider rate(s) saved successfully..

datastring or null
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

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 .

422 Validation failed

Validation error. A unit other than Per Hour or Per Minute (for example weekly) is refused and nothing is saved. The message is under errors.unit.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "unit": [
      "The unit must be Per Hour or Per Minute (hr or min)."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields..

errorsarray of object
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..