> ## 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. # Read a contract's write-off and its recoveries > Answers the write-off of a contract with the debt frozen at it, the total recovered, the debt still standing, the control still open and the latest 100 recoveries, newest first. A contract never written off is refused (LENDER-0977). It also shows when the client operator declared collection ended and the business day the control left the books. ## OpenAPI ````yaml /es/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/write-off 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: get: tags: - Loan Accounts summary: Read a contract's write-off and its recoveries description: >- Answers the write-off of a contract with the debt frozen at it, the total recovered, the debt still standing, the control still open and the latest 100 recoveries, newest first. A contract never written off is refused (LENDER-0977). It also shows when the client operator declared collection ended and the business day the control left the books. operationId: getCreditLossWriteOff 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 responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreditLossWriteOffStandingResponse' 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 '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: CreditLossWriteOffStandingResponse: additionalProperties: false properties: additionalLoss: description: >- Loss above the allowance booked to provision expense: W - B when positive (2 d.p. string). examples: - '3850.00' type: string carryingAmount: description: >- Carrying amount written off (W): the book net of the withheld interest, after the held cash paid what it reached (2 d.p. string). examples: - '9850.00' type: string collectionEndedAt: description: >- RFC 3339 instant the client operator declared collection ended; absent until declared. format: date-time type: string collectionEndedBy: description: Subject that declared it. type: string controlOpen: description: >- Written-off control still open (2 d.p. string); 0.00 once it was released. examples: - '0.00' type: string controlReleasedAt: description: >- Business day the rest of the control left the books, the later of 5 years after the write-off and the declared end; absent while it stands. examples: - '2032-03-10' format: date type: string currency: description: ISO 4217 currency of the amounts. examples: - BRL type: string debtAtWriteOff: description: >- Debt D the borrower still owes after the write-off: the contract's full payoff of the write-off day, frozen at the write-off; recoveries pay it down (2 d.p. string). examples: - '11600.00' type: string heldCashApplied: description: >- Held cash the write-off's receipt applied to the debt first (2 d.p. string). examples: - '150.00' type: string id: description: Recorded write-off. format: uuid type: string loanAccountId: description: Written-off loan account. format: uuid type: string provisionConsumed: description: >- Provision the write-off consumed: the lesser of the allowance B and W (2 d.p. string). examples: - '6000.00' type: string provisionReleased: description: >- Allowance beyond the loss booked as a provision reversal: B - W when positive (2 d.p. string). examples: - '0.00' type: string reason: description: Why the contract was written off. type: string recordedBy: description: >- Subject of the validated identity that wrote it off; empty when none reached the route. type: string recoveredTotal: description: >- Recovered so far across every standing recovery, reversed ones excluded (2 d.p. string). examples: - '10200.00' type: string recoveries: description: The latest 100 recoveries, newest first, reversed ones included. items: $ref: '#/components/schemas/CreditLossRecoveryResponse' type: - array - 'null' remainingDebt: description: >- Debt still standing: debtAtWriteOff minus recoveredTotal (2 d.p. string). examples: - '1400.00' type: string requestId: description: X-Idempotency key the write-off was recorded under. type: string withheldDerecognized: description: Withheld interest cleared from rendas a apropriar (2 d.p. string). examples: - '1600.00' type: string writtenOffAt: description: >- RFC 3339 instant the write-off was recorded, with fractional seconds; the server clock dates it. format: date-time type: string required: - recoveredTotal - remainingDebt - controlOpen - recoveries - id - requestId - loanAccountId - writtenOffAt - reason - recordedBy - currency - carryingAmount - heldCashApplied - withheldDerecognized - provisionConsumed - additionalLoss - provisionReleased - debtAtWriteOff 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 CreditLossRecoveryResponse: additionalProperties: false properties: amount: description: Money received (2 d.p. string). examples: - '9000.00' type: string controlReleased: description: Written-off control the recovery released (2 d.p. string). examples: - '8650.00' type: string currency: description: ISO 4217 currency of the amounts. examples: - BRL type: string id: description: Recorded recovery. format: uuid type: string loanAccountId: description: Written-off loan account. format: uuid type: string receivedAt: description: RFC 3339 instant the money arrived, with fractional seconds. format: date-time type: string recordedAt: description: RFC 3339 instant the recovery was recorded. format: date-time type: string recordedBy: description: >- Subject of the validated identity that recorded it; empty when none reached the route. type: string recoveredBefore: description: >- Recovered by the recoveries recorded before this one (2 d.p. string). examples: - '1200.00' type: string remainingAfter: description: Debt still standing after this recovery (2 d.p. string). examples: - '1400.00' type: string requestId: description: X-Idempotency key the recovery was recorded under. type: string reversedAt: description: >- RFC 3339 instant the recovery was reversed, with fractional seconds; absent while it stands. A reversed recovery no longer counts in recoveredTotal, remainingDebt or controlOpen. format: date-time type: string reversedBy: description: Subject that reversed it. type: string taxAmount: description: >- PIS/COFINS booked on the taxed part; 0.00 when nothing is taxed (2 d.p. string). examples: - '16.28' type: string taxedAmount: description: 'Part above W: new revenue, taxed by PIS/COFINS (2 d.p. string).' examples: - '350.00' type: string untaxedAmount: description: >- Part that settles the written-off amount W first: untaxed (2 d.p. string). examples: - '8650.00' type: string writeOffId: description: Write-off the recovery pays down. format: uuid type: string required: - id - writeOffId - loanAccountId - requestId - amount - receivedAt - recordedAt - recordedBy - currency - recoveredBefore - untaxedAmount - taxedAmount - taxAmount - controlReleased - remainingAfter 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.