Create a deal

Create a deal with its borrower, parties, contacts and loans. The applicant's application is started in Accend once the deal is ready.

Borrower, parties and contacts may be linked by Accend id, linked by your own external id, or created inline; loans are always created. One idempotency_key per request makes retries safe.

post/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

idempotency_keystring required

Stable per-request key, unique within your organization; a Salesforce caller uses the Opportunity id. A retry with the same key and an equivalent payload returns the original result (200, deduplicated=true). The same key with a different payload is 409 idempotency_key_payload_mismatch.

external_deal_idstring nullable

Your own id for the deal, unique within your organization: a second deal with the same value is 409 external_deal_id_taken.

programstring nullable

Program key from your organization's catalog. Selects the credit policy, the workflow, the intake template and the document set the applicant is asked for. Omit for the organization's default program. Unknown key: 400 unknown_program; retired key: 400 program_disabled.

namestring required

descriptionstring nullable

initial_stage'draft' | 'intake' nullable

Where the deal starts; normally omitted, which starts it at the program's first stage (normally draft). Only these two entry points are accepted; later stages are reached through the workflow.

origination'intake' | 'outreach'

allow_linkboolean

currencystring nullable

Base currency for the deal's rollups and the default for any loan below that omits one; defaults to the borrower's currency, then USD. ISO 4217, case-insensitive; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCG, XDR, XOF, XPF, YER, ZAR, ZMW, ZWL.

requested_limitnumber nullable

Total credit requested for the deal, in the deal's currency. The loans below are the product slices of that line.

custom_attributesobject nullable

Response

Replay. Returned only when the same idempotency_key is retried with an equivalent payload: the body is the stored result of the original 201 with deduplicated=true.

deduplicatedboolean

True when a stored result was replayed for a repeated idempotency_key instead of a new deal being created.

Changes

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