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

# Validate a batch of contracts already running at a cut

> Runs every check of the load against the real dependencies and writes nothing; the CRM is read, never written.



## OpenAPI

````yaml /en/openapi/v3-current/lender.yaml post /api/v1/br/contract-opening-batches/dry-run
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/contract-opening-batches/dry-run:
    post:
      tags:
        - Contract opening
      summary: Validate a batch of contracts already running at a cut
      description: >-
        Runs every check of the load against the real dependencies and writes
        nothing; the CRM is read, never written.
      operationId: dryRunContractOpeningBatch
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                cutDate:
                  type: string
                lines:
                  items:
                    $ref: '#/components/schemas/ContractOpeningLineRequest'
                  type:
                    - array
                    - 'null'
                reason:
                  type: string
                sellerCnpj:
                  type: string
              required:
                - reason
                - cutDate
                - lines
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractOpeningDryRunResponse'
          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: >-
            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:
    ContractOpeningLineRequest:
      additionalProperties: false
      properties:
        acquisitionPrice:
          type: string
        balances:
          $ref: '#/components/schemas/OpeningBalancesRequest'
        borrowerDocument:
          type: string
        borrowerName:
          type: string
        contractNumber:
          type: string
        flow:
          items:
            $ref: '#/components/schemas/OpeningFlowRequest'
          type:
            - array
            - 'null'
        guarantees:
          items:
            $ref: '#/components/schemas/GuaranteeAttachmentRequest'
          type:
            - array
            - 'null'
        loanProductVersionId:
          type: string
        original:
          $ref: '#/components/schemas/OpeningOriginalRequest'
        pdd:
          $ref: '#/components/schemas/OpeningPDDRequest'
        priorModification:
          $ref: '#/components/schemas/OpeningPriorModRequest'
        problemAsset:
          $ref: '#/components/schemas/OpeningProblemAssetRequest'
        registration:
          $ref: '#/components/schemas/OpeningRegistrationRequest'
        terms:
          $ref: '#/components/schemas/OpeningTermsRequest'
      required:
        - contractNumber
        - loanProductVersionId
        - borrowerDocument
        - borrowerName
        - original
        - terms
        - flow
        - balances
        - pdd
      type: object
    ContractOpeningDryRunResponse:
      additionalProperties: false
      properties:
        cutDate:
          type: string
        failedCount:
          format: int64
          type: integer
        lineCount:
          format: int64
          type: integer
        lines:
          items:
            $ref: '#/components/schemas/ContractOpeningLineResultHuma'
          type:
            - array
            - 'null'
        reason:
          enum:
            - conversion
            - acquisition
          type: string
        refusedCount:
          format: int64
          type: integer
        validCount:
          format: int64
          type: integer
      required:
        - reason
        - cutDate
        - lineCount
        - validCount
        - refusedCount
        - failedCount
        - lines
      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
    OpeningBalancesRequest:
      additionalProperties: false
      properties:
        accruedInterest:
          type: string
        additionalAllowance:
          type: string
        feeToAmortize:
          type: string
        incurredAllowance:
          type: string
        lateCharges:
          type: string
        principal:
          type: string
        suspendedInterest:
          type: string
      required:
        - principal
        - accruedInterest
        - lateCharges
      type: object
    OpeningFlowRequest:
      additionalProperties: false
      properties:
        accrualDate:
          type: string
        dueDate:
          type: string
        indexCode:
          type: string
        indexPercentage:
          type: string
        indexSpread:
          type: string
        interest:
          type: string
        originalNumber:
          format: int64
          type: integer
        principal:
          type: string
      required:
        - originalNumber
        - dueDate
        - principal
        - interest
      type: object
    GuaranteeAttachmentRequest:
      additionalProperties: false
      properties:
        coveredPercentage:
          type: string
        executedAt:
          type: string
        externalReference:
          type: string
        spec:
          $ref: '#/components/schemas/GuaranteeSpecRequest'
      required:
        - externalReference
        - coveredPercentage
      type: object
    OpeningOriginalRequest:
      additionalProperties: false
      properties:
        annualEffectiveRate:
          type: string
        contractDate:
          type: string
        contractedAmount:
          type: string
        iofDailyPercent:
          type: string
      required:
        - contractDate
        - contractedAmount
        - annualEffectiveRate
        - iofDailyPercent
      type: object
    OpeningPDDRequest:
      additionalProperties: false
      properties:
        allocatedOn:
          type: string
        defaultedOn:
          type: string
        motive:
          type: string
        stage:
          type: string
      required:
        - stage
        - allocatedOn
        - motive
      type: object
    OpeningPriorModRequest:
      additionalProperties: false
      properties:
        lastRenegotiatedOn:
          type: string
        lastRestructuredOn:
          type: string
      type: object
    OpeningProblemAssetRequest:
      additionalProperties: false
      properties:
        evaluatedOn:
          type: string
        evidenceReference:
          type: string
        trigger:
          type: string
      required:
        - trigger
        - evaluatedOn
        - evidenceReference
      type: object
    OpeningRegistrationRequest:
      additionalProperties: false
      properties:
        ccbNumber:
          type: string
        registradora:
          type: string
        registradoraName:
          type: string
        registrationCode:
          type: string
        registrationDate:
          type: string
      required:
        - registradora
        - registrationCode
      type: object
    OpeningTermsRequest:
      additionalProperties: false
      properties:
        amortizationSystem:
          type: string
        dayCount:
          type: string
        monthlyRate:
          type: string
        rateKind:
          type: string
      required:
        - amortizationSystem
        - dayCount
        - rateKind
        - monthlyRate
      type: object
    ContractOpeningLineResultHuma:
      additionalProperties: false
      properties:
        code:
          description: The LENDER code of a refused or failed line.
          type: string
        contractNumber:
          description: Echoed only when it passed its validator.
          type: string
        detail:
          description: Fixed text, up to 240 characters.
          type: string
        lineNumber:
          description: >-
            The 1-based position of the line in the batch:
            body.lines[lineNumber-1].
          format: int64
          type: integer
        loanAccountId:
          description: >-
            The account the line opened; on LENDER-1804, the one that already
            holds the contract.
          type: string
        location:
          description: The field of the refusal, lines and flow indexed from 0.
          type: string
        outcome:
          enum:
            - valid
            - opened
            - refused
            - failed
          type: string
      required:
        - lineNumber
        - outcome
      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
    GuaranteeSpecRequest:
      additionalProperties: false
      properties:
        description:
          type: string
        guarantor:
          $ref: '#/components/schemas/GuarantorRequest'
        identification:
          type: string
        originalValue:
          type: string
        revaluation:
          $ref: '#/components/schemas/GuaranteeRevaluationInput'
        scr:
          $ref: '#/components/schemas/GuaranteeSCRInput'
      required:
        - description
        - scr
      type: object
    GuarantorRequest:
      additionalProperties: false
      properties:
        document:
          type: string
        name:
          type: string
      required:
        - document
        - name
      type: object
    GuaranteeRevaluationInput:
      additionalProperties: false
      properties:
        percentage:
          type: string
        reassessedOn:
          type: string
        value:
          type: string
      required:
        - reassessedOn
      type: object
    GuaranteeSCRInput:
      additionalProperties: false
      properties:
        situation:
          type: string
        type:
          type: string
        valueType:
          type: string
      required:
        - type
        - valueType
        - situation
      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.