Assignment Batch Retrieval

Retrieves the full details of a specific assignment batch, including the assignment configuration, the current status, the event history, the disbursement data and the financial amounts.

Available on

Profile	Host	Required permission
Manager	`manager-api`	Read
Consultant	`consultant-api`	View Assignments
Assignor	`assignor-api`	Read

Base URL for each host: Environments (Hosts).

When to use

Use this endpoint to check the current state of a batch at any point in the flow — for example, to verify whether the batch has already passed eligibility, whether it has been approved or whether the payment has been made. It is also the query to make when creation returns a duplicate (TRC000041).

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}

METHOD

GET

Path params

Parameter	Type	Description
`fund_class_key`	string	Unique fund key (UUID).
`assignment_configuration_key`	string	Assignment configuration key (UUID).
`assignment_external_id`	string	The `external_id` provided when the batch was created.

Response

STATUS

200

Response Body

Response Body
{
  "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
  "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
  "name": "CESSÃO #12345",
  "assignment_configuration": {
    "assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
    "validation_configuration_key": "5f0e3a4c-2b7d-4c1e-9a8f-0d6b1c2e3f40",
    "assignment_configuration_name": "Config CCB Fundo Alpha",
    "assignment_contract_key": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "registry_type": "internal_registry",
    "asset_type": "ccb",
    "fund_class": {
      "fund_class_key": "f1a2b3c4-d5e6-4890-abcd-ef1234567890",
      "name": "Fundo Alpha FIDC",
      "document_number": "11.222.333/0001-81",
      "accounting_date": "2024-04-01",
      "manager": {
        "manager_key": "e1f2a3b4-c5d6-4890-abcd-ef1234567890",
        "document_number": "22.222.222/0001-91",
        "manager_name": "Gestora Exemplo S.A."
      }
    },
    "assignor": {
      "assignor_key": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
      "document_number": "33.333.333/0001-91",
      "name": "Cedente Exemplo Ltda"
    },
    "assignment_reports": {
      "send_reports": false
    },
    "assignment_configuration_type": "default_configuration",
    "status": "active",
    "consultant_decision_type": "manual_approval",
    "manager_decision_type": "manual_approval",
    "asset_fees": null,
    "payment_type": "pix",
    "custody_type": "internal",
    "required_documents": ["ccb"],
    "after_assignment_required_documents": [],
    "certifier": "certifiqi",
    "disbursement_account_policy": "all_assignor_accounts",
    "consultant": {
      "consultant_key": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",
      "document_number": "44.444.444/0001-91",
      "name": "Consultoria Exemplo Ltda"
    },
    "operation_type": "unsecured_credit",
    "originator_bonds": [
      {
        "originator": {
          "originator_key": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
          "document_number": "33.333.333/0001-91",
          "name": "Cedente Exemplo Ltda"
        }
      }
    ]
  },
  "assignment_number": "12345",
  "assignment_date": "2024-04-01",
  "status": "completed",
  "assignment_term_key": "b1c2d3e4-f5a6-4890-abcd-ef1234567890",
  "disbursement": {
    "target_account": {
      "account_key": "d1e2f3a4-b5c6-4890-abcd-ef1234567890",
      "account_type": "checking_account",
      "account_branch": "0001",
      "account_number": "12345",
      "account_digit": "4",
      "financial_institution_code": "341",
      "financial_institution_ispb": "60701190",
      "owner": {
        "document_number": "33.333.333/0001-91"
      },
      "payment_type": "pix"
    }
  },
  "origin_type": "client",
  "payment_type": "pix",
  "assignment_total_value": 150000.00,
  "assignment_irr": 0.0215,
  "status_events": [
    {
      "status": "pending_assets_insertion",
      "event_datetime": "2024-04-01 10:00:00.123456",
      "selected_agent": {
        "AGENT-TYPE": "assignor",
        "AGENT-KEY": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
        "AGENT-USER": "usuario@exemplo.com"
      }
    },
    {
      "status": "completed_assets_insertion",
      "event_datetime": "2024-04-01 11:30:00.654321"
    },
    {
      "status": "completed",
      "event_datetime": "2024-04-01 16:00:00.000000"
    }
  ]
}

Response attributes

Field	Type	Description
`assignment_key`	string	Unique batch identifier generated by QI Tech (UUID).
`external_id`	string	External key provided by the partner at creation.
`name`	string	Assignment identifier name.
`assignment_number`	string	Assignment batch number.
`assignment_date`	string	Assignment date in `YYYY-MM-DD` format.
`status`	string	Current batch status. See the batch statuses.
`origin_type`	string	Batch origin. Batches created through the integration API have `client`.
`payment_type`	string \| null	Payment method to the assignor: `pix` or `wire_transfer`. Comes from the batch or, if not provided there, from the assignment configuration.
`assignment_term_key`	string \| null	Assignment Term key (UUID). Filled in after the term is generated.
`assignment_total_value`	number	Total assignment amount in reais. Absent until the first calculation, made when insertion is closed.
`assignment_irr`	number	Internal rate of return of the batch. Absent while not calculated.
`assignment_configuration`	object	Assignment configuration of the batch. The fields are in Assignment Configuration Listing.
`disbursement`	object \| null	Disbursement account of the batch, in `target_account`, with the account fields and the `payment_type` used. `null` while not defined.
`assignor_discounts`	array	Assignor discounts. Present only when the batch has discounts. See table below.
`status_events`	array	History of the batch status transitions. See table below.

`assignor_discounts` attributes

Field	Type	Description
`assignor_discount_key`	string	Unique discount key (UUID).
`assignor_discount_type`	string	`expense_reimbursement` or `others`.
`status`	string	`created`, `pending_execution`, `executed` or `rejected`.
`total_value`	number	Discount amount in reais.
`description`	string	Discount description.

`status_events` attributes

Field	Type	Description
`status`	string	Status the batch moved to.
`event_datetime`	string	Date and time of the transition, in UTC, in `YYYY-MM-DD HH:MM:SS.ffffff` format.
`selected_agent`	object	Agent that made the transition (`AGENT-TYPE`, `AGENT-KEY` and `AGENT-USER`). Absent in automatic transitions.
`denial_reason`	string	Present in `denied` and `discarded`: origin of the denial or discard (`eligibility`, `registry`, `accounting_close`, `payment`, `manager`, `asset_documents`, `manual`, `consultant` or `inconsistency`).
`denial_metadata`	object	Denial details, when any — for example, the eligibility rules that failed or the `denial_reason` sent in the approval.

Errors

Status	Code	When it happens
404	`TRC000016`	The combination of `fund_class_key` and `assignment_configuration_key` does not match any assignment configuration.
404	`TRC000018`	No batch with this `external_id` in this assignment configuration.

Authentication, permission and host errors: see API Errors.

Request​

Path params​

Response​

Response attributes​

assignor_discounts attributes​

status_events attributes​

Errors​