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.
| Field | Type | Description |
|---|---|---|
serviceType required | array of object (2 nested) | Multi-select service types |
serviceProviderType required | array of object (2 nested) | Multi-select provider types |
certification | array of object or null (2 nested) | Multi-select certifications |
rateType required | array of object (2 nested) | Multi-select rate types |
siteType required | array of object (2 nested) | Multi-select site types |
specialization | array of object or null (2 nested) | Multi-select specializations |
providerRole | array of object or null (2 nested) | Multi-select provider roles |
unit required | string | Example |
rate required | number | Example |
minimumDuration | integer or null | Example |
assignment | boolean | Example |
shift | boolean | Example |
Nested fields
serviceType 2 fields
| Field | Type | Description |
|---|---|---|
serviceType[].id | integer | Example |
serviceType[].label | string | Example |
serviceProviderType 2 fields
| Field | Type | Description |
|---|---|---|
serviceProviderType[].id | integer | Example |
serviceProviderType[].label | string | Example |
certification 2 fields
| Field | Type | Description |
|---|---|---|
certification[].id | integer | Example |
certification[].label | string | Example |
rateType 2 fields
| Field | Type | Description |
|---|---|---|
rateType[].id | integer | Example |
rateType[].label | string | Example |
siteType 2 fields
| Field | Type | Description |
|---|---|---|
siteType[].id | string | Example |
siteType[].label | string | Example |
specialization 2 fields
| Field | Type | Description |
|---|---|---|
specialization[].id | integer | Example |
specialization[].label | string | Example |
providerRole 2 fields
| Field | Type | Description |
|---|---|---|
providerRole[].id | string | Example |
providerRole[].label | string | Example |
Example
{
"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
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.
{
"success": true,
"message": "12 provider rate(s) saved successfully.",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | string or null |
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
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 |
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.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | array of object |
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 |