Update Expected Totals

Updates the expected total for a transaction category on an event.

This endpoint is used to set or update reserve amounts for categories that support reserves.

Important: Amounts are in dollars (not cents) for this endpoint.

Required permission: company.claim:update or company.incident:update (depending on event type)

PATCH /api/external/companies/{companyId}/events/{eventId}/financials/expected-totals

cURL

updateIndemnityReserve

curl --request PATCH \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/expected-totals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "claim",
  "categoryId": "indemnity_invoice",
  "expectedTotal": 15000
}
'

200

success

{
  "eventId": "550e8400-e29b-41d4-a716-446655440001",
  "categoryId": "indemnity_invoice",
  "expectedTotal": 15000,
  "reserves": 10000
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

eventId · string<uuid> · required

Event identifier

Body

application/json

Request body for updating expected totals on an event

type · enum<string> · required

Type of event (claim or incident)

Available options: claim, incident

categoryId · string · required

Transaction category identifier (must support reserves)

expectedTotal · number · required

Expected total amount in dollars (not cents)

Required range: x >= 0

asOfDate · string<date>

Historical date for the update (YYYY-MM-DD, optional)

Response

200

application/json

Expected total updated successfully

Response from updating expected totals

eventId · string<uuid>

Event identifier

categoryId · string

Transaction category identifier

expectedTotal · number | null

Updated expected total in dollars (null if not found)

reserves · number | null

Reserve amount for the category in dollars (null if not applicable)