--- title: "Record an identified financial impact." method: POST path: "/v1/impacts" --- # Record an identified financial impact. `POST /v1/impacts` ## Request - Base URL: `https://api.candor.money` - URL: `https://api.candor.money/v1/impacts` - Auth: HTTP bearer Record an identified financial impact. ## Headers - `Idempotency-Key` string, required ## Request body - union - object - `category` 'money_recovered' | 'spending_reduced' | 'fees_or_interest_reduced' | 'income_or_yield_increased' | 'benefit_or_reward_captured' | 'tax_cost_reduced' | 'time_returned', required: The typed financial mechanism, not a merchant-specific label. - `benefit_summary` string, required: How this could benefit the user, in plain language that remains useful when the current conversation is gone. - `identified_at` string, date-time: When the agent decided to act on the specific reviewed finding. - `potential_value` union: Exact value without mixed units. Gross benefit and implementation cost remain separate; one-time, bounded, recurring, and time value never collapse into one headline number. - object - `kind` 'one_time', required: Treat this as one-time money. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - object - `kind` 'bounded_total', required: Treat this as a total over one explicit window. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `window_start` string, date-time, required: Inclusive start of the value window. - `window_end` string, date-time, required: Inclusive end of the value window. - object - `kind` 'recurring_rate', required: Treat this as a recurring money rate. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `interval` 'monthly' | 'annual', required: Cadence of the recurring value. - object - `kind` 'time', required: Treat this as time returned to the user. - `duration` string, required: Positive exact decimal duration. - `unit` 'minutes' | 'hours', required: Unit of the returned time. - `basis_refs` FinancialImpactBasisRef[], required: Typed records supporting the identified opportunity. Omit only when context_note_id carries the reconstructable calculation and caveats instead. - union: A typed record supporting the impact. The id is resolved inside the same vault; an arbitrary resource string is never accepted. - object - `type` 'transaction', required: Reference a transaction. - `id` string, required: Transaction id supporting the impact. - object - `type` 'account', required: Reference a canonical account identity. - `id` string, required: Account identity id supporting the impact. - object - `type` 'recurring_item', required: Reference a recurring financial item. - `id` string, required: Recurring item id supporting the impact. - object - `type` 'goal', required: Reference a first-class financial goal. - `id` string, required: Goal id supporting the impact. - object - `type` 'action', required: Reference a prior Candor action that records why it happened. - `id` string, required: Action id supporting the impact. - `context_note_id` string: A note containing the reconstructable calculation, caveats, or external context for the identified opportunity. Use basis_refs instead when canonical Candor records directly support the claim. - object - `category` 'money_recovered' | 'spending_reduced' | 'fees_or_interest_reduced' | 'income_or_yield_increased' | 'benefit_or_reward_captured' | 'tax_cost_reduced' | 'time_returned', required: The typed financial mechanism, not a merchant-specific label. - `benefit_summary` string, required: How this could benefit the user, in plain language that remains useful when the current conversation is gone. - `identified_at` string, date-time: When the agent decided to act on the specific reviewed finding. - `potential_value` union: Exact value without mixed units. Gross benefit and implementation cost remain separate; one-time, bounded, recurring, and time value never collapse into one headline number. - object - `kind` 'one_time', required: Treat this as one-time money. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - object - `kind` 'bounded_total', required: Treat this as a total over one explicit window. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `window_start` string, date-time, required: Inclusive start of the value window. - `window_end` string, date-time, required: Inclusive end of the value window. - object - `kind` 'recurring_rate', required: Treat this as a recurring money rate. - `gross_benefit` union, required: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `implementation_cost` union: Exact Money input using a supported currency code, one space, and a plain signed decimal within Candor's supported range. - string - string - string - `interval` 'monthly' | 'annual', required: Cadence of the recurring value. - object - `kind` 'time', required: Treat this as time returned to the user. - `duration` string, required: Positive exact decimal duration. - `unit` 'minutes' | 'hours', required: Unit of the returned time. - `basis_refs` FinancialImpactBasisRef[]: Typed records supporting the identified opportunity. Omit only when context_note_id carries the reconstructable calculation and caveats instead. - union: A typed record supporting the impact. The id is resolved inside the same vault; an arbitrary resource string is never accepted. - object - `type` 'transaction', required: Reference a transaction. - `id` string, required: Transaction id supporting the impact. - object - `type` 'account', required: Reference a canonical account identity. - `id` string, required: Account identity id supporting the impact. - object - `type` 'recurring_item', required: Reference a recurring financial item. - `id` string, required: Recurring item id supporting the impact. - object - `type` 'goal', required: Reference a first-class financial goal. - `id` string, required: Goal id supporting the impact. - object - `type` 'action', required: Reference a prior Candor action that records why it happened. - `id` string, required: Action id supporting the impact. - `context_note_id` string, required: A note containing the reconstructable calculation, caveats, or external context for the identified opportunity. Use basis_refs instead when canonical Candor records directly support the claim. ## Response `200` Created financial impact envelope. - ResponseEnvelope - `schema_version` string, required - `generated_at` string, date-time, required - `request_id` string, required - `status` 'success' | 'partial_success' | 'action_required' | 'error', required - `user_message` string: Optional concise user-safe message the calling agent may adapt. - `data_freshness` DataFreshness - `balances_last_synced_at` string - `coverage` 'complete' | 'partial' | 'stale' | 'unavailable', required - `holdings_last_synced_at` string - `transactions_last_synced_at` string - `metadata` object: Response-level protocol metadata such as package compatibility and workspace opening identity or timing. It is not financial workspace data and must not be treated as attention. - `view_url` string, uri: Authenticated dashboard destination related to this response. May open a section rather than reproduce the returned records or filters. Per-record view_url values identify exact supported record views. Use returned URLs instead of constructing paths. - `warnings` object[], required - `errors` AgentError[], required - `code` string, required - `expires_at` string - `idempotency_key` string: Stable key to reuse when retrying this identical logical operation. - `message` string, required - `recovery_url` string, uri - `required_capability` string - `retry_after_seconds` integer: Machine-actionable delay before retrying the identical logical operation. - `retryable` boolean, required - `suggested_command` string - `next_actions` AgentAction[], required - `intent` string, required - `command` string, required - `args` object, required - `shell` string, required - `action` WorkspaceAction - `id` string, required - `operation` string, required - `reason` string, required - `root_action_id` string, required - `parent_action_id` string - `task_key` string - `status` 'started' | 'succeeded' | 'refused' | 'failed', required - `created_at` string, date-time, required - `completed_at` string, date-time - `data` object, nullable, required: Operation-specific result data, or null when the request ends in an error. ## Other responses - `default`: Structured Candor error envelope with machine-readable codes, recovery guidance, and retry timing when applicable. --- [API](https://skmtc.dev/candor/apis/candor-api.md) · [All operations](https://skmtc.dev/candor/apis/candor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/candor/apis/candor-api/revisions/6c050f72e956?raw)