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

# Open the exception case of an integration item that stopped

> Opens an integration_item_stuck case for one item, keyed on set, receivableRef, destination, purpose and step, or answers the case already open for it: a retry writes nothing and gets the same case. Refused with LENDER-0541 for an unknown set, LENDER-0545 before approval, LENDER-0548 for a receivable the set no longer carries and LENDER-1502 once the set is cancelled or settled.



## OpenAPI

````yaml /es/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/integration-cases
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/assignment/sets/{setId}/integration-cases:
    post:
      tags:
        - AssignmentExceptions
      summary: Open the exception case of an integration item that stopped
      description: >-
        Opens an integration_item_stuck case for one item, keyed on set,
        receivableRef, destination, purpose and step, or answers the case
        already open for it: a retry writes nothing and gets the same case.
        Refused with LENDER-0541 for an unknown set, LENDER-0545 before
        approval, LENDER-0548 for a receivable the set no longer carries and
        LENDER-1502 once the set is cancelled or settled.
      operationId: openAssignmentIntegrationCase
      parameters:
        - description: Assignment set identifier.
          in: path
          name: setId
          required: true
          schema:
            description: Assignment set identifier.
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenAssignmentIntegrationCaseHumaInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignmentExceptionHumaBody'
          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
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '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:
    OpenAssignmentIntegrationCaseHumaInputBody:
      additionalProperties: false
      properties:
        attempts:
          description: Delivery attempts made.
          format: int64
          minimum: 0
          type: integer
        destination:
          description: The integration destination.
          pattern: ^[a-z][a-z0-9_]{0,31}$
          type: string
        externalCode:
          description: The destination's code, or the orchestrator's reason.
          pattern: ^[A-Za-z0-9_.:-]{0,64}$
          type: string
        fields:
          description: Names of the fields the destination refused.
          items:
            pattern: ^[A-Za-z][A-Za-z0-9_.]{0,63}$
            type: string
          maxItems: 20
          type:
            - array
            - 'null'
        httpStatus:
          description: >-
            The destination's last HTTP status; 0 or absent when nothing
            answered.
          format: int64
          maximum: 599
          minimum: 0
          type: integer
        itemStatus:
          description: Where the item stopped.
          enum:
            - rejected
            - blocked
            - outcome_unknown
          type: string
        purpose:
          description: Why the item is delivered, for example assignment_offer.
          pattern: ^[a-z][a-z0-9_]{0,63}$
          type: string
        receivableRef:
          description: >-
            The receivable the item is about; absent for a step about the whole
            set.
          maxLength: 128
          type: string
        step:
          description: >-
            The integration step that stopped, for example contract or
            attachment.ccb.
          pattern: ^[a-z][a-z0-9_.-]{0,63}$
          type: string
      required:
        - destination
        - purpose
        - step
        - itemStatus
      type: object
    AssignmentExceptionHumaBody:
      additionalProperties: false
      properties:
        assignmentFundId:
          description: The fund it was offered to.
          type: string
        assignmentSetId:
          description: The set this case happened to.
          type: string
        caseType:
          description: >-
            What happened: repeated_cut, remessa_conflict, remessa_divergence,
            offer_sent_without_remessa (the fund returned no file within its
            window after the offer was sent), derecognition_unpostable (the
            receivable's product carries no write-off posting rule),
            derecognition_unvaluable (the receivable's carried figure cannot be
            read or cannot be trusted), derecognition_already_sold (another
            assignment set has already sold this receivable),
            derecognition_unsellable (the receivable is not this tenant's to
            sell: suspended, excluded, ported or already discharged),
            derecognition_contract_closed (the receivable's debt closed after
            approval; the detail names the cause), transfer_absent (the
            administrator accepted a receivable whose title movement no
            registradora ever confirmed), registry_command_unconfirmed (a title
            transfer commanded at the registradora that never came back
            settled), assigned_contract_passthrough, fund_payment_divergence
            (what the fund paid for the lot differs from what its paid lines are
            due beyond the lot's tolerance; the acceptance is held, and
            detail.fundPayment names the numbers, amountPaid net of what the
            desk refunded for lines taken out), integration_item_stuck (an
            integration item the orchestrator could not deliver; one case per
            set, receivable, destination, purpose and step), or one of the
            lifecycle orphans.
          type: string
        detail:
          description: >-
            A JSON object with what a desk needs to act: the cut tally that
            tripped the brake, the two conflicting digests, the references that
            failed to reconcile. A case whose line was taken out of its lot
            carries removedLine: the line's frozen faceValue, assignmentPrice,
            discountAmount and currency, factsRecorded (paid, transferred) for
            how far the fund got with it, and refundToFund, what the exception
            desk settles with the fund for it: what the fund paid for the line
            less its share of the lot's accepted or tolerated difference. An
            integration_item_stuck case carries destination, purpose, step,
            itemStatus and attempts, with httpStatus, externalCode and fields
            when known, and once resolved by resend or delivered-outside,
            resolutionAction: resend or delivered_outside.
          type: string
        disposition:
          description: What they decided; resolved cases only.
          type: string
        id:
          description: Case identifier (uuid).
          type: string
        openedAt:
          description: UTC instant the case was opened (RFC3339).
          type: string
        receivableRef:
          description: >-
            The one receivable this case is about; empty when the case is about
            a whole file.
          type: string
        resolvedAt:
          description: UTC instant it was disposed of (RFC3339); resolved cases only.
          type: string
        resolvedBy:
          description: Validated identity that disposed of it; resolved cases only.
          type: string
        state:
          description: open or resolved.
          type: string
      required:
        - id
        - caseType
        - assignmentSetId
        - assignmentFundId
        - receivableRef
        - state
        - detail
        - openedAt
      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
    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.