> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # 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). ## OpenAPI ````yaml /en/openapi/v3-current/lender.yaml put /api/v1/internal/accounting/suspense-accounts/{currency}/{role} openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Code-first OpenAPI 3.1 surface for the Lender service. Routes that move money are at-most-once per X-Idempotency: when one answers 5xx, the X-Idempotency-Fenced response header says whether that key is now refusing resends (true) or free to retry (false or absent). license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Caller session projection: validated subject and effective permissions for the presented token. name: Session - description: >- Ledger accounting operations: journal entries and accrual postings for loan accounts. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Accounting - description: >- Loan application intake and lifecycle: submission, decisioning, and status. name: LoanApplications - description: >- Loan product catalog: definition, versioning, and activation of lending products. name: LoanProducts - description: >- Loan account servicing operations: balances, schedules, and account-level actions. name: Loan Accounts - description: >- Portfolio dashboard read operations: aggregated portfolio and performance views. name: Dashboard - description: >- Jurisdiction registry: supported jurisdiction profiles and their capabilities. name: Jurisdictions - description: >- Jurisdiction-specific loan application operations (Brazil origination surface). name: Loan Applications - description: >- Tax computation operations for jurisdiction-specific lending (e.g. Brazil IOF). name: Tax - description: >- Brazil consignado privado operations: contract lifecycle, exclusion repair, and compensating adjustments. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Consignado - description: >- Inbound record quarantine. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Streaming - description: >- Credit-instrument document template registry: versioned drafting and publication of CCB clausulado. name: DocumentTemplates paths: /api/v1/internal/accounting/suspense-accounts/{currency}/{role}: put: tags: - Accounting summary: Designate the tenant's account for a currency and role description: >- 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). operationId: putSuspenseAccount parameters: - description: ISO 4217 code of the asset the account holds. in: path name: currency required: true schema: description: ISO 4217 code of the asset the account holds. examples: - BRL pattern: ^[A-Z]{3}$ type: string - description: >- 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. in: path name: role required: true schema: description: >- 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. enum: - suspense - below - above - loss examples: - below type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutSuspenseAccountHumaInputBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SuspenseAccountHumaBody' description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '413': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Request Entity Too Large '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable '504': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Gateway Timeout default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: PutSuspenseAccountHumaInputBody: additionalProperties: false properties: gl_account: description: >- 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). examples: - 2100-90-001 maxLength: 128 minLength: 1 type: string required: - gl_account type: object SuspenseAccountHumaBody: additionalProperties: false properties: currency: description: ISO 4217 code of the asset the account holds. examples: - BRL type: string gl_account: description: GL account in the tenant's ledger. examples: - 2100-90-001 type: string role: description: What the account takes. enum: - suspense - below - above - loss examples: - below type: string required: - currency - role - gl_account type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.