Financials
Loans

Create a new loan

post/api/v1/financials/loans

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/loans
  • Auth: none declared

Request body

namestring required
descriptionstring nullable
external_loan_idstring nullable
idempotency_keystring required
deal_idstring required
initial_stagestring nullable

Initial loan lifecycle stage; defaults to the program's first stage

product_type'term_loan' | 'revolver' | 'overdraft' | 'guarantee' | 'other' required
currencystring nullable

The currency of the loan; defaults to the deal's currency

limit_amountnumber required
interest_type'fixed' | 'floating' | 'other' required
interest_ratenumber

The interest rate of the loan (e.g. 5.25 for 5.25%)

interest_benchmark'sofr' | 'prime' | 'fed_funds' | 'treasury' | 'other'
interest_spreadnumber nullable

Percent over the benchmark (e.g. 2.75 for benchmark + 2.75%)

repayment_type'amortizing' | 'bullet' | 'interest_only' | 'revolving' | 'other' required
amortization_monthsinteger nullable

Amortization period in months; a balloon is implied when longer than the term

balloon_amountnumber nullable

Scheduled final lump-sum (balloon) payment amount

billing_cycle'daily' | 'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'other'
purpose'working_capital' | 'capital_expenditure' | 'refinancing' | 'real_estate_purchase' | 'growth_capital' | 'acquisition' | 'equipment_purchase' | 'other' required
seniority'senior_secured' | 'senior_unsecured' | 'subordinated' | 'mezzanine' | 'other'
prepayment_penaltystring nullable

Prepayment penalty terms, e.g. '3-2-1 step-down'

unused_fee_ratenumber nullable

Annual percent charged on the undrawn commitment (e.g. 0.25)

start_datestring date required

The start date of the loan in ISO 8601 date format

maturity_datestring date nullable

The maturity date of the loan in ISO 8601 date format

custom_attributesobject nullable

Response

Successful Response

loan_idstring required
namestring required
descriptionstring nullable
external_loan_idstring nullable
idempotency_keystring required
deal_idstring required
product_type'term_loan' | 'revolver' | 'overdraft' | 'guarantee' | 'other' required
currencystring

The currency of the loan

limit_amountnumber required
interest_type'fixed' | 'floating' | 'other' required
interest_ratenumber
interest_benchmark'sofr' | 'prime' | 'fed_funds' | 'treasury' | 'other'
interest_spreadnumber nullable
repayment_type'amortizing' | 'bullet' | 'interest_only' | 'revolving' | 'other' required
amortization_monthsinteger nullable
balloon_amountnumber nullable
billing_cycle'daily' | 'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'other'
purpose'working_capital' | 'capital_expenditure' | 'refinancing' | 'real_estate_purchase' | 'growth_capital' | 'acquisition' | 'equipment_purchase' | 'other' required
seniority'senior_secured' | 'senior_unsecured' | 'subordinated' | 'mezzanine' | 'other'
prepayment_penaltystring nullable
unused_fee_ratenumber nullable
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.

start_datestring date required
maturity_datestring date nullable
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.