Designate the tenant's account for a currency and role

Creates or replaces the GL account the validated tenant designates for one currency and role. A disbursement in parts posts what is still owed to the borrower to below and what was paid over the liberated amount to above; an excess the borrower keeps is written off to loss; the CCB residual and the other compensating adjustments post to suspense. A contract keeps the account its first amount in a role was booked into, for every later part and adjustment in that role; a new account applies to contracts with none booked yet. A contract whose earlier amounts sit in more than one account resolves none: the adjustment create is then refused 422, nothing is recorded and the divergence stays adjustable. A designated account must already exist in the ledger; the Lender never creates or changes it, except one named exactly as its role’s default, which is treated as the default and ensured by the Lender. below and suspense are credit-directed (deposit; suspense with overdraft enabled); above and loss are debit-directed (lender_debit, registered with defaultDirection debit before the account is created). When the Lender provisions ledger accounts, a BRL role with no designated account books into the Lender’s default, which it creates in the posting’s ledger with that direction: suspense -> suspensao-brl (credit, overdraft enabled), below -> valores-a-liberar-brl (credit), above -> pago-a-maior-brl (debit), loss -> perdas-brl (debit).

PUT /api/v1/internal/accounting/suspense-accounts/{currency}/{role}

Designate the tenant's account for a currency and role

cURL

curl --request PUT \
  --url https://lender.sandbox.lerian.net/api/v1/internal/accounting/suspense-accounts/{currency}/{role} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gl_account": "2100-90-001"
}
'

200

{
  "currency": "BRL",
  "gl_account": "2100-90-001",
  "role": "below"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

currency · string · obrigatório

ISO 4217 code of the asset the account holds.

Pattern: ^[A-Z]{3}$

Exemplo:

"BRL"

role · enum<string> · obrigatório

suspense: the CCB's own residual, on either side. below: still owed to the borrower in a disbursement in parts (valores a liberar ao tomador). above: paid over the liberated amount (pago a maior). loss: the expense a disbursement excess the borrower keeps is written off to.

Opções disponíveis: suspense, below, above, loss

Exemplo:

"below"

Corpo

application/json

gl_account · string · obrigatório

GL account in the tenant's ledger, as its Midaz alias: at most 50 letters, digits, ':', '_' and '-', with an optional leading '@', or @external/ (LENDER-0429 otherwise).

Required string length: 1 - 128

Exemplo:

"2100-90-001"

Resposta

200

application/json

OK

currency · string · obrigatório

ISO 4217 code of the asset the account holds.

Exemplo:

"BRL"

gl_account · string · obrigatório

GL account in the tenant's ledger.

Exemplo:

"2100-90-001"

role · enum<string> · obrigatório

What the account takes.

Opções disponíveis: suspense, below, above, loss

Exemplo:

"below"