Get financial summary for an assignment
GET /v1/assignments/{id}/financial-summary
- Scope
assignments:read finance:read- Roles
- admin, scheduler
Retrieves comprehensive financial data including client charges, provider compensation, and profit/loss for a specific assignment or shift.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Assignment ID (ASG-XXX) or Shift ID (SFT-XXX) |
Query parameters
| Name | Type | Description |
|---|---|---|
clientsPage | integer | Page of the clients breakdown (default: 1). Example |
clientsPerPage | integer | Rows per page of the clients breakdown, 1 to 100. Example |
providersPage | integer | Page of the providers breakdown (default: 1). Example |
providersPerPage | integer | Rows per page of the providers breakdown, 1 to 100. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/assignments/{id}/financial-summary" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Financial summary retrieved successfully
Financial summary retrieved successfully
{
"success": true,
"message": "Financial summary retrieved successfully",
"data": {
"clientChargesSummary": {
"description": "Short human-readable description.",
"clients": [
{}
],
"totalBilledToClients": 120.5
},
"providerCompensationSummary": {
"description": "Short human-readable description.",
"providers": [
{}
],
"totalProviderPayouts": 120.5
},
"financialOutcome": {
"totalRevenue": 120.5,
"totalProviderPayouts": 120.5,
"netProfitLoss": 120.5,
"adminFee": 120.5,
"providerAdminFee": 120.5,
"totalAdminFee": 120.5
},
"linkedFinanceDocuments": {
"active": {},
"historical": {}
},
"providerNoShowFinance": {},
"missingActiveInvoice": true,
"missingActivePayable": true
}
}Response fields (24)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (21 nested) |
Nested fields
data 21 fields
| Field | Type | Description |
|---|---|---|
data.clientChargesSummary | object | |
data.clientChargesSummary.description | string | Example |
data.clientChargesSummary.clients | array of object | |
data.clientChargesSummary.totalBilledToClients | number (float) | Example |
data.providerCompensationSummary | object | |
data.providerCompensationSummary.description | string | Example |
data.providerCompensationSummary.providers | array of object | |
data.providerCompensationSummary.totalProviderPayouts | number (float) | Example |
data.financialOutcome | object | |
data.financialOutcome.totalRevenue | number (float) | Example |
data.financialOutcome.totalProviderPayouts | number (float) | Example |
data.financialOutcome.netProfitLoss | number (float) | Example |
data.financialOutcome.adminFee | number (float) | Organization/scheduler admin fee included in totalRevenue Example |
data.financialOutcome.providerAdminFee | number (float) | Provider admin fee included in totalProviderPayouts Example |
data.financialOutcome.totalAdminFee | number (float) | adminFee + providerAdminFee Example |
data.linkedFinanceDocuments | object | |
data.linkedFinanceDocuments.active | object | |
data.linkedFinanceDocuments.historical | object | |
data.providerNoShowFinance | object | |
data.missingActiveInvoice | boolean | Example |
data.missingActivePayable | boolean | Example |
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
Unauthorized - User does not have permission to view financial data
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'assignments:read' 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 |
404 Not found
Assignment or Shift not found
{
"success": false,
"message": "The requested resource could not be found.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. 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
Server error
{
"success": false,
"message": "An unexpected error occurred — please try again.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator. |
code | string | Always empty: the server-error response carries no error code. Example |