> ## 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. # Obter descritor de operação de crédito > Retorna o descritor de operação de crédito da Res. CMN 5.004/2022, opcionalmente reconstruído em uma data de negócio. ## OpenAPI ````yaml pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/credit-descriptor openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: Superfície OpenAPI 3.1 code-first do serviço Lender. license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Operações de contabilidade do ledger: entradas de journal e lançamentos de accrual para contas de empréstimo. name: Accounting - description: >- Recepção e ciclo de vida da solicitação de empréstimo: submissão, decisão e status. name: LoanApplications - description: >- Catálogo de produtos de empréstimo: definição, versionamento e ativação de produtos de crédito. name: LoanProducts - description: >- Operações de servicing de contas de empréstimo: saldos, cronogramas e ações em nível de conta. name: Loan Accounts - description: >- Operações de leitura de servicing: cronogramas de pagamento e estado de servicing para contas de empréstimo. name: Servicings - description: >- Operações de leitura do painel de carteira: visões agregadas de carteira e de desempenho. name: Dashboard - description: >- Registro de jurisdições: perfis de jurisdição suportados e suas capacidades. name: Jurisdictions - description: >- Operações de solicitação de empréstimo específicas por jurisdição (superfície de originação do Brasil). name: Loan Applications - description: >- Operações de cálculo de impostos para crédito específico por jurisdição (por exemplo, IOF do Brasil). name: Tax - description: >- Operações de consignado privado do Brasil: originação de contrato (contratação ativa) e ciclo de vida. name: Consignado paths: /api/v1/br/loan-accounts/{id}/credit-descriptor: get: tags: - Loan Accounts summary: Obter descritor de operação de crédito description: >- Retorna o descritor de operação de crédito da Res. CMN 5.004/2022, opcionalmente reconstruído em uma data de negócio. operationId: getLoanAccountCreditOperationDescriptor parameters: - description: Loan account identifier. in: path name: id required: true schema: description: Loan account identifier. format: uuid type: string - description: Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor. explode: false in: query name: asOfDate schema: description: Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor. format: date type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreditOperationDescriptorResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: CreditOperationDescriptorResponse: additionalProperties: false properties: accrualState: description: 'Interest accrual state: accruing or suspended; omitted when not set.' examples: - accruing type: string annualRate: description: >- Contractual nominal annual interest rate as a percentage decimal string. examples: - '24.50' type: string asOfDate: description: >- Valuation date the financial figures are reconstructed as of (YYYY-MM-DD, UTC). examples: - '2026-06-14' type: string cetAnnualPct: description: Custo Efetivo Total, annualized, as a percentage decimal string. examples: - '28.40' type: string cetMonthlyPct: description: Custo Efetivo Total, monthly, as a percentage decimal string. examples: - '2.11' type: string consumerProtectionRegime: description: >- Applicable consumer-protection regime label; omitted when not classified. type: string createdAt: description: RFC3339 UTC timestamp when the descriptor record was created. examples: - '2026-06-14T12:00:00Z' type: string descriptorDate: description: Date the descriptor snapshot was generated (YYYY-MM-DD, UTC). examples: - '2026-06-14' type: string id: description: >- Unique identifier (UUID) of the credit operation descriptor snapshot. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string installmentCount: description: Total number of installments in the amortization schedule. examples: - 24 format: int64 type: integer iofAmount: description: >- IOF (Imposto sobre Operacoes Financeiras) amount as a decimal string, scale 2; omitted when not applicable. examples: - '50.34' type: string jurisdictionCode: description: ISO jurisdiction code governing the descriptor (e.g. "BR"). examples: - BR type: string lastPaymentDate: description: >- Date of the most recent payment received (YYYY-MM-DD, UTC); omitted if no payment recorded. examples: - '2026-06-14' type: string loanAccountId: description: UUID of the loan account the descriptor summarizes. examples: - 550e8400-e29b-41d4-a716-446655440001 type: string loanApplicationId: description: UUID of the originating loan application. examples: - 550e8400-e29b-41d4-a716-446655440002 type: string monthlyRate: description: >- Contractual nominal monthly interest rate as a percentage decimal string. examples: - '1.85' type: string nextDueDate: description: >- Due date of the next scheduled installment (YYYY-MM-DD, UTC); omitted if none pending. examples: - '2026-06-14' type: string originalTerm: description: Original contracted term of the loan in number of installments. examples: - 24 format: int64 type: integer outstandingBalance: description: >- Total outstanding balance (principal plus accrued charges) as a decimal string, scale 2. examples: - '43250.75' type: string overdueInstallmentCount: description: Number of installments currently past due. examples: - 1 format: int64 type: integer paidInstallmentCount: description: Number of installments fully paid to date. examples: - 6 format: int64 type: integer pddStage: description: >- Current PDD delinquency staging: one of current, stage_1, stage_2, stage_3; omitted when unstaged. examples: - stage_1 type: string prepaymentSettlementId: description: >- UUID of the prepayment settlement that closed the operation; omitted unless settled via prepayment. examples: - 550e8400-e29b-41d4-a716-446655440003 type: string principalOutstanding: description: >- Outstanding principal as a decimal string in major currency units, scale 2. examples: - '42000.00' type: string profileVersion: description: Jurisdiction profile version used to compute the descriptor. examples: - 1.0.0 type: string refreshedAt: description: >- RFC3339 UTC timestamp when the descriptor figures were last refreshed. examples: - '2026-06-14T12:00:00Z' type: string status: description: Lifecycle status of the credit operation (e.g. active, settled). examples: - active type: string totalCharges: description: >- Cumulative fees and charges as a decimal string in major currency units, scale 2. examples: - '320.00' type: string totalTaxes: description: >- Cumulative taxes as a decimal string in major currency units, scale 2. examples: - '86.84' type: string required: - id - loanAccountId - loanApplicationId - descriptorDate - asOfDate - profileVersion - jurisdictionCode - status - principalOutstanding - outstandingBalance - annualRate - monthlyRate - cetAnnualPct - cetMonthlyPct - originalTerm - installmentCount - paidInstallmentCount - overdueInstallmentCount - totalCharges - totalTaxes - refreshedAt - createdAt type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 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 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 securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````