> ## 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.

# Get payoff statement



## OpenAPI

````yaml en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}
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.
  license:
    name: Lerian Studio General License
  title: Lender API
  version: 1.0.0
servers:
  - url: https://lender.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Ledger accounting operations: journal entries and accrual postings for
      loan accounts.
    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: >-
      Servicing read operations: repayment schedules and servicing state for
      loan accounts.
    name: Servicings
  - 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 origination (contratação
      ativa) and lifecycle.
    name: Consignado
paths:
  /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}:
    get:
      tags:
        - Loan Accounts
      summary: Get payoff statement
      operationId: getPayoffStatement
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: quote_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoffStatementResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    PayoffStatementResponse:
      additionalProperties: false
      properties:
        chargeDiscount:
          type: string
        currency:
          type: string
        expiresAt:
          format: date-time
          type: string
        grossAmount:
          type: string
        instrument:
          $ref: '#/components/schemas/PayoffInstrumentResponse'
        interestDiscount:
          type: string
        iofReconciliation:
          type: string
        loanAccountId:
          format: uuid
          type: string
        netAmount:
          type: string
        principalOutstanding:
          type: string
        quoteId:
          format: uuid
          type: string
        slaDueAt:
          format: date-time
          type: string
        slaStatus:
          enum:
            - pending
            - met
            - breached
          type: string
        statementAvailableAt:
          format: date-time
          type: string
      required:
        - quoteId
        - loanAccountId
        - principalOutstanding
        - interestDiscount
        - chargeDiscount
        - iofReconciliation
        - grossAmount
        - netAmount
        - currency
        - statementAvailableAt
        - slaDueAt
        - slaStatus
        - expiresAt
        - instrument
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    PayoffInstrumentResponse:
      additionalProperties: false
      properties:
        boleto:
          $ref: '#/components/schemas/PayoffBoletoInstructions'
        id:
          format: uuid
          type: string
        issuedAt:
          format: date-time
          type: string
        pix:
          $ref: '#/components/schemas/PayoffPIXInstructions'
        requestedAt:
          format: date-time
          type: string
        status:
          enum:
            - requested
            - issued
            - paid
            - expired
            - cancelled
            - failed
          type: string
        type:
          enum:
            - pix
            - boleto
          type: string
      required:
        - id
        - type
        - status
        - requestedAt
      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
    PayoffBoletoInstructions:
      additionalProperties: false
      properties:
        barcode:
          type: string
        digitableLine:
          type: string
        documentUrl:
          format: uri
          type: string
      type: object
    PayoffPIXInstructions:
      additionalProperties: false
      properties:
        copyPasteCode:
          type: string
        qrCodeUrl:
          format: uri
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````