> ## 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. # Declare that collection of a written-off contract ended > Records that the client operator exhausted the collection of a written-off contract (Res. CMN 4.966 art. 49 par. 1). The write-off's control leaves the books once, the day a daily job finds both this declaration and 5 full years since the write-off (the later of the two): it releases the control left, W less every release a recovery made. Without the declaration the control stays open after 5 years. The declaration is made once: the same X-Idempotency key replays it and moves nothing; another key is refused (LENDER-0981). A contract never written off is refused (LENDER-0977). Recoveries stay open after the exit and are split at W as before. ## OpenAPI ````yaml /en/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/write-off/collection-end 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/br/loan-accounts/{id}/write-off/collection-end: post: tags: - Loan Accounts summary: Declare that collection of a written-off contract ended description: >- Records that the client operator exhausted the collection of a written-off contract (Res. CMN 4.966 art. 49 par. 1). The write-off's control leaves the books once, the day a daily job finds both this declaration and 5 full years since the write-off (the later of the two): it releases the control left, W less every release a recovery made. Without the declaration the control stays open after 5 years. The declaration is made once: the same X-Idempotency key replays it and moves nothing; another key is refused (LENDER-0981). A contract never written off is refused (LENDER-0977). Recoveries stay open after the exit and are split at W as before. operationId: endCreditLossCollection parameters: - description: Written-off direct-credit loan account. in: path name: id required: true schema: description: Written-off direct-credit loan account. format: uuid type: string - description: >- Idempotency key of the declaration: 1 to 255 bytes of UTF-8. The route refuses a request without it, or with a blank, longer or non-UTF-8 one (LENDER-0965). X-Request-ID is never read as the key. in: header name: X-Idempotency schema: description: >- Idempotency key of the declaration: 1 to 255 bytes of UTF-8. The route refuses a request without it, or with a blank, longer or non-UTF-8 one (LENDER-0965). X-Request-ID is never read as the key. type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreditLossCollectionEndResponse' description: Created headers: X-Idempotency-Replayed: schema: description: >- "true" when this response replays an earlier request with the same X-Idempotency key; absent on a first execution. type: string '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 '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: CreditLossCollectionEndResponse: additionalProperties: false properties: collectionEndedAt: description: >- RFC 3339 instant the declaration was recorded; the server clock dates it. format: date-time type: string collectionEndedBy: description: >- Subject of the validated identity that declared it; empty when none reached the route. type: string loanAccountId: description: Written-off loan account. format: uuid type: string requestId: description: X-Idempotency key the declaration was recorded under. type: string writeOffId: description: Write-off whose collection ended. format: uuid type: string required: - writeOffId - loanAccountId - requestId - collectionEndedAt - collectionEndedBy 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.