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

# Preview jurisdiction tax amounts

> Computes disbursement IOF tax amounts using the active compiled jurisdiction profile without persisting data.



## OpenAPI

````yaml en/openapi/v3-current/lender.yaml post /api/v1/br/tax/preview
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/tax/preview:
    post:
      tags:
        - Tax
      summary: Preview jurisdiction tax amounts
      description: >-
        Computes disbursement IOF tax amounts using the active compiled
        jurisdiction profile without persisting data.
      operationId: previewTax
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxPreviewHumaBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxPreviewEnvelopeResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    TaxPreviewHumaBody:
      additionalProperties: false
      properties:
        disbursementDate:
          description: Disbursement date (RFC3339).
          examples:
            - '2026-06-14T12:00:00Z'
          format: date-time
          type: string
        finalDueDate:
          description: Final due date (RFC3339).
          examples:
            - '2026-06-14T12:00:00Z'
          format: date-time
          type: string
        grossAmount:
          description: >-
            Gross disbursement amount in major currency units (e.g.
            "100000.00").
          examples:
            - '100000.00'
          type: string
        jurisdictionCode:
          description: ISO 3166-1 alpha-2 jurisdiction code (e.g. "BR").
          examples:
            - BR
          maxLength: 2
          minLength: 2
          type: string
        netDeliveredAmount:
          description: Optional net delivered amount in major currency units.
          examples:
            - '99913.16'
          type: string
        taxRegime:
          description: Tax regime selector understood by the jurisdiction tax engine.
          type: string
      required:
        - grossAmount
        - disbursementDate
        - finalDueDate
        - taxRegime
        - jurisdictionCode
      type: object
    TaxPreviewEnvelopeResponse:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/TaxPreviewResponse'
          description: >-
            The computed tax-preview result (IOF, PIS, COFINS, and net delivered
            amount) for the requested disbursement.
      required:
        - data
      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
    TaxPreviewResponse:
      additionalProperties: false
      properties:
        cofins:
          description: >-
            COFINS contribution amount, decimal string in major currency units
            (scale 2).
          examples:
            - '30.00'
          type: string
        grossAmount:
          description: >-
            Gross disbursement amount before tax, decimal string in major
            currency units (scale 2).
          examples:
            - '100000.00'
          type: string
        iofAdditional:
          description: >-
            Additional fixed-rate IOF component, decimal string in major
            currency units (scale 2).
          examples:
            - '38.00'
          type: string
        iofDaily:
          description: >-
            Daily IOF component, decimal string in major currency units (scale
            2).
          examples:
            - '12.34'
          type: string
        jurisdictionCode:
          description: ISO 3166-1 alpha-2 jurisdiction code (e.g. "BR").
          examples:
            - BR
          type: string
        netDeliveredAmount:
          description: >-
            Net amount delivered to the borrower after tax deduction, decimal
            string in major currency units (scale 2).
          examples:
            - '99913.16'
          type: string
        pis:
          description: >-
            PIS contribution amount, decimal string in major currency units
            (scale 2).
          examples:
            - '6.50'
          type: string
        profileVersion:
          description: >-
            Compiled jurisdiction profile version used to compute the preview
            (e.g. "1.0.0").
          examples:
            - 1.0.0
          type: string
        rateTableSnapshotId:
          description: >-
            Identifier of the rate-table snapshot whose rates produced these
            amounts.
          examples:
            - 550e8400-e29b-41d4-a716-446655440002
          type: string
        taxRegime:
          description: Tax regime selector applied by the jurisdiction tax engine.
          type: string
        totalIof:
          description: >-
            Sum of daily and additional IOF, decimal string in major currency
            units (scale 2).
          examples:
            - '50.34'
          type: string
        totalTax:
          description: >-
            Total tax (IOF + PIS + COFINS), decimal string in major currency
            units (scale 2).
          examples:
            - '86.84'
          type: string
      required:
        - iofDaily
        - iofAdditional
        - totalIof
        - pis
        - cofins
        - totalTax
        - grossAmount
        - netDeliveredAmount
        - taxRegime
        - jurisdictionCode
        - profileVersion
        - rateTableSnapshotId
      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

````