Financials
Deals

Update a deal

Provide either deal_id or external_deal_id to identify the deal to update.

put/api/v1/financials/deals

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/deals
  • Auth: HTTP bearer

Request body

OR

Response

Successful Response

deal_idstring required
namestring required
descriptionstring nullable
main_borrower_idstring required
stagestring required
status'in_progress' | 'on_hold' | 'withdrawn' | 'cancelled' | 'rejected' | 'duplicate' required

Universal operational state for deals and loans — the "what's happening right now?" axis, independent of product. Lifecycle position lives in the per-program stage column. There is no positive terminal here; "done well" is expressed by stage reaching active/closed_out. The four negative terminals freeze the stage wherever it was.

programstring required
monitoring_status'performing' | 'watch' | 'workout'

Deal-level health sub-state, only meaningful while stage == active. A coarse operational bucketing of credit health; a finer risk_rating rolls up into it. Reviews/covenant breaches move this; they never move stage.

origination'intake' | 'outreach'
allow_linkboolean
currencystring
analyst_user_idstring nullable
secondary_analyst_user_idstring nullable
sales_rep_user_idstring nullable
requested_limitnumber nullable
approved_limitnumber nullable
allocated_limitnumber nullable
allocated_limit_is_convertedboolean
custom_attributesobject nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.