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

# Price the tenant's IOF for one borrower kind

> Makes these alíquotas the kind's IOF for every disbursement from now on, as a new version of the tenant's rate table; every other kind keeps its rates. A disbursement already made keeps the version it withheld at. The deployment ships pessoaFisica priced and pessoaJuridica and simplesNacional unpriced (LENDER-0233 at disbursement, LENDER-0900 at the tax preview).



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml put /api/v1/br/tax/iof-rates/{borrowerKind}
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/tax/iof-rates/{borrowerKind}:
    put:
      tags:
        - Tax
      summary: Price the tenant's IOF for one borrower kind
      description: >-
        Makes these alíquotas the kind's IOF for every disbursement from now on,
        as a new version of the tenant's rate table; every other kind keeps its
        rates. A disbursement already made keeps the version it withheld at. The
        deployment ships pessoaFisica priced and pessoaJuridica and
        simplesNacional unpriced (LENDER-0233 at disbursement, LENDER-0900 at
        the tax preview).
      operationId: putIOFRate
      parameters:
        - description: >-
            The rate-table key a disbursement reads: the borrower kind, or
            simplesNacional for a pessoa jurídica under the Simples Nacional
            regime whose operation is R$ 30.000,00 or less (Decreto 6.306/2007,
            art. 7, VI).
          in: path
          name: borrowerKind
          required: true
          schema:
            description: >-
              The rate-table key a disbursement reads: the borrower kind, or
              simplesNacional for a pessoa jurídica under the Simples Nacional
              regime whose operation is R$ 30.000,00 or less (Decreto
              6.306/2007, art. 7, VI).
            enum:
              - pessoaFisica
              - pessoaJuridica
              - simplesNacional
            examples:
              - pessoaJuridica
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutIOFRateHumaInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IOFRatesHumaBody'
          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
        '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: Error
components:
  schemas:
    PutIOFRateHumaInputBody:
      additionalProperties: false
      properties:
        additionalPercent:
          description: >-
            One-off additional alíquota of art. 7, § 15, in percent: 0.38 is
            0,38%. Above 1.5 is LENDER-0935; a sign or more than 6 decimals is
            refused by the schema.
          examples:
            - '0.38'
          pattern: ^[0-9]{1,2}(\.[0-9]{1,6})?$
          type: string
        changedBy:
          description: >-
            Who makes the change, read only when the deployment runs without
            authentication; an authenticated subject always wins. A change
            naming nobody is refused LENDER-0941.
          examples:
            - tax-desk
          maxLength: 256
          type: string
        dailyPercent:
          description: >-
            Daily alíquota in percent, as the decree writes it: 0.0082 is
            0,0082% ao dia. Above 1.5, the maximum of art. 6, is LENDER-0935; a
            sign or more than 6 decimals is refused by the schema.
          examples:
            - '0.0082'
          pattern: ^[0-9]{1,2}(\.[0-9]{1,6})?$
          type: string
        sourceReference:
          description: The legal basis of the rate, kept with it.
          examples:
            - >-
              Decreto 6.306/2007, art. 7, I, b, 1, redação do Decreto
              12.499/2025; ADC 96 cautelar em vigor
          maxLength: 512
          pattern: \S
          type: string
      required:
        - dailyPercent
        - additionalPercent
        - sourceReference
      type: object
    IOFRatesHumaBody:
      additionalProperties: false
      properties:
        changedBy:
          description: >-
            Who priced the version; empty for the version the deployment
            shipped.
          type: string
        effectiveFrom:
          description: When the version came into force.
          format: date-time
          type: string
        rateTableSnapshotId:
          description: The version a disbursement made now pins.
          examples:
            - br-tax-rates-v1
          type: string
        rates:
          description: >-
            The kinds priced, sorted by key. A kind absent here is refused:
            LENDER-0233 at disbursement, LENDER-0900 at the tax preview.
          items:
            $ref: '#/components/schemas/IOFRateHumaBody'
          type:
            - array
            - 'null'
        sourceReference:
          description: The legal basis cited; empty for the version the deployment shipped.
          type: string
      required:
        - rateTableSnapshotId
        - effectiveFrom
        - changedBy
        - sourceReference
        - rates
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    IOFRateHumaBody:
      additionalProperties: false
      properties:
        additionalPercent:
          description: Additional alíquota in percent.
          examples:
            - '0.38'
          type: string
        borrowerKind:
          description: The rate-table key.
          examples:
            - pessoaJuridica
          type: string
        dailyPercent:
          description: Daily alíquota in percent.
          examples:
            - '0.0082'
          type: string
        dayCap:
          description: Taxable days per instalment, art. 7, § 1.
          examples:
            - 365
          format: int64
          type: integer
      required:
        - borrowerKind
        - dailyPercent
        - additionalPercent
        - dayCap
      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.