Corgi BankDocumentation
OpenAPI

Set the interest plan on a ledger account

PUT/ledger/accounts/{id}/interest-plan

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

annual_rate_bpsintegerRequired
day_countstringRequired
expense_gl_codestringRequired
source_refstringRequired
tieringobject or nullOptional
2 child attributes
methodstringRequired

Whole_balance (Reg DD method A) or marginal (method B)

tiersarray of objectsRequired
2 child attributes
annual_rate_bpsintegerRequired
minimum_balance_minorintegerRequired

Returns

200 OK

accrued_liability_amountintegerRequired

The whole cents of Cumulative recognised on GL 2150

annual_rate_bpsintegerRequired
cumulativestringRequired
day_countstringRequired
expense_gl_codestringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_cyclestringRequired
source_refstringRequired
statusstringRequired
tieringobject or nullOptional
2 child attributes
methodstringRequired

Whole_balance (Reg DD method A) or marginal (method B)

tiersarray of objectsRequired
2 child attributes
annual_rate_bpsintegerRequired
minimum_balance_minorintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close