API reference › Assignments

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

NameTypeDescription
id requiredstring

Assignment ID (ASG-XXX) or Shift ID (SFT-XXX)

Query parameters

NameTypeDescription
clientsPageinteger

Page of the clients breakdown (default: 1).

Example 1.

clientsPerPageinteger

Rows per page of the clients breakdown, 1 to 100.

Example 10.

providersPageinteger

Page of the providers breakdown (default: 1).

Example 1.

providersPerPageinteger

Rows per page of the providers breakdown, 1 to 100.

Example 10.

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

Example request

Shell
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

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Financial summary retrieved successfully.

dataobject (21 nested)

Nested fields

data 21 fields
FieldTypeDescription
data.clientChargesSummaryobject
data.clientChargesSummary.descriptionstring

Example Short human-readable description..

data.clientChargesSummary.clientsarray of object
data.clientChargesSummary.totalBilledToClientsnumber (float)

Example 120.5.

data.providerCompensationSummaryobject
data.providerCompensationSummary.descriptionstring

Example Short human-readable description..

data.providerCompensationSummary.providersarray of object
data.providerCompensationSummary.totalProviderPayoutsnumber (float)

Example 120.5.

data.financialOutcomeobject
data.financialOutcome.totalRevenuenumber (float)

Example 120.5.

data.financialOutcome.totalProviderPayoutsnumber (float)

Example 120.5.

data.financialOutcome.netProfitLossnumber (float)

Example 120.5.

data.financialOutcome.adminFeenumber (float)

Organization/scheduler admin fee included in totalRevenue

Example 120.5.

data.financialOutcome.providerAdminFeenumber (float)

Provider admin fee included in totalProviderPayouts

Example 120.5.

data.financialOutcome.totalAdminFeenumber (float)

adminFee + providerAdminFee

Example 120.5.

data.linkedFinanceDocumentsobject
data.linkedFinanceDocuments.activeobject
data.linkedFinanceDocuments.historicalobject
data.providerNoShowFinanceobject
data.missingActiveInvoiceboolean

Example true.

data.missingActivePayableboolean

Example true.

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

Unauthorized - User does not have permission to view financial data

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

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'assignments:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment or Shift not found

JSON
{
  "success": false,
  "message": "The requested resource could not be found.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The requested resource could not be found..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

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

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .