> ## 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. # Close a short retained instalment from the desk > One posting applies the cash on the desk to the instalment (Dr cash) and books the rest as the client's credit loss (Dr the product's provision expense), crediting the retained account for the whole instalment, with the art. 49 § 1 written_off_credit control opened in the same transaction. The posting is dated at the close. The closing actor is the caller's validated identity. Refused, with nothing written, when the escrituração cannot price the instalment yet, the employer withheld more than it sent, no instalment cash arrived, or the cash already covers it. Idempotent via the X-Idempotency header enforced by the platform middleware. ## OpenAPI ````yaml /es/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/retained-installments/{id}/close 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/br/consignado/retained-installments/{id}/close: post: tags: - Consignado summary: Close a short retained instalment from the desk description: >- One posting applies the cash on the desk to the instalment (Dr cash) and books the rest as the client's credit loss (Dr the product's provision expense), crediting the retained account for the whole instalment, with the art. 49 § 1 written_off_credit control opened in the same transaction. The posting is dated at the close. The closing actor is the caller's validated identity. Refused, with nothing written, when the escrituração cannot price the instalment yet, the employer withheld more than it sent, no instalment cash arrived, or the cash already covers it. Idempotent via the X-Idempotency header enforced by the platform middleware. operationId: closeConsignadoRetainedInstallment parameters: - description: The retained instalment. in: path name: id required: true schema: description: The retained instalment. format: uuid type: string - description: >- Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction. in: header name: X-Idempotency required: true schema: description: >- Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseRetainedInstallmentHumaInputBody' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RetainedInstallmentCloseHumaBody' description: Created headers: X-Idempotency-Replayed: description: >- "true" when this response replays a request already executed under the same X-Idempotency, so nothing ran a second time and no money moved again. Absent on a first execution. schema: type: string '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- The at-most-once contract refused the request before any handler ran: no X-Idempotency header (IDEMPOTENCY_KEY_REQUIRED), a key under a spelling this service does not read (IDEMPOTENCY_KEY_HEADER_UNKNOWN), or a request that could not be scoped to a tenant (IDEMPOTENCY_TENANT_REQUIRED). The code is in the problem document's `code` member. '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 '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '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: >- Any other status this operation may carry, rendered as a problem document — including a refusal produced ahead of the service, such as a gateway or ingress answering on its behalf. components: schemas: CloseRetainedInstallmentHumaInputBody: additionalProperties: false properties: reason: description: Why the rest is the client's loss, kept with the close. maxLength: 512 minLength: 1 type: string required: - reason type: object RetainedInstallmentCloseHumaBody: additionalProperties: false properties: carvedOutAt: description: RFC 3339 instant the instalment was carved out at the sale. format: date-time type: string cash: description: The cash on the desk the close applies to it (2 d.p. string). examples: - '187.40' type: string closedAt: description: RFC 3339 instant of the close, which dates the posting. format: date-time type: string competencia: description: YYYYMM payroll cycle of the instalment. type: string currency: description: ISO 4217 currency code. type: string id: description: The retained instalment; the id the close route takes. format: uuid type: string numeroContrato: description: Consignado contract number. type: string owed: description: What the instalment owes the client (2 d.p. string). examples: - '250.00' type: string rest: description: What the close books as the client's credit loss (2 d.p. string). examples: - '62.60' type: string required: - closedAt - id - numeroContrato - competencia - currency - owed - cash - rest - carvedOutAt 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.