Assignment Batch Retrieval

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

When to use

Use this endpoint to check the current state of a batch at any point in the flow — for example, to verify if the batch has passed eligibility, if the manager has already approved it, or if payment has been made.

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 at batch creation.

Response

STATUS

200

Response Body
{
  "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
  "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
  "name": "ASSIGNMENT #12345",
  "assignment_configuration": {
    "assignment_configuration_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "validation_configuration_key": "v1w2x3y4-z5a6-7890-abcd-ef1234567890",
    "assignment_configuration_name": "CCB Config Fund Alpha",
    "assignment_contract_key": "k1l2m3n4-o5p6-7890-abcd-ef1234567890",
    "registry_type": "internal_registry",
    "asset_type": "ccb",
    "assignment_configuration_type": "standard",
    "consultant_decision_type": "manual_approval",
    "asset_fees": null,
    "assignment_reports": null,
    "fund_class": {
      "fund_class_key": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "name": "Alpha FIDC Fund",
      "document_number": "12.345.678/0001-90",
      "accounting_date": "2024-04-01",
      "manager": {
        "manager_key": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
        "document_number": "11.222.333/0001-44",
        "manager_name": "Example Manager S.A."
      }
    },
    "assignor": {
      "assignor_key": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
      "document_number": "98.765.432/0001-10",
      "name": "Example Assignor Ltda"
    },
    "consultant": {
      "consultant_key": "g1h2i3j4-k5l6-7890-abcd-ef1234567890",
      "document_number": "55.666.777/0001-88",
      "name": "Example Consulting Ltda"
    },
    "originator_bonds": [
      {
        "originator": {
          "originator_key": "h1i2j3k4-l5m6-7890-abcd-ef1234567890",
          "document_number": "22.333.444/0001-55",
          "name": "Example Originator Ltda"
        }
      }
    ],
    "webhook_configuration_bonds": [
      {
        "webhook_configuration_bond": {
          "webhook_configuration_key": "w1x2y3z4-a5b6-7890-abcd-ef1234567890",
          "agent_type": "assignor",
          "agent_key": "c1d2e3f4-a5b6-7890-abcd-ef1234567890"
        },
        "signature_key": "s1t2u3v4-w5x6-7890-abcd-ef1234567890",
        "webhook_url": "https://partner.example.com/webhooks/trade_receivables"
      }
    ]
  },
  "assignment_number": "00012345",
  "assignment_date": "2024-04-01",
  "status": "completed",
  "origin_type": "client",
  "assignment_term_key": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
  "disbursement": {
    "target_account": {
      "account_key": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
      "account_type": "checking_account",
      "account_branch": "001",
      "account_number": "12345",
      "account_digit": "4",
      "financial_institution_code": "341",
      "financial_institution_ispb": "60701190",
      "owner": {
        "document_number": "98.765.432/0001-10"
      }
    }
  },
  "assignment_total_value": 150000.00,
  "assignment_irr": 0.0215,
  "assignor_discounts": [
    {
      "assignor_discount_key": "ad12e3f4-a5b6-7890-abcd-ef1234567890",
      "assignor_discount_type": "flat_rate",
      "status": "approved",
      "total_value": 500.00,
      "description": "Administration fee"
    }
  ],
  "status_events": [
    {
      "status": "pending_assets_insertion",
      "event_datetime": "2024-04-01 10:00:00"
    },
    {
      "status": "completed_assets_insertion",
      "event_datetime": "2024-04-01 11:30:00"
    },
    {
      "status": "pending_eligibility",
      "event_datetime": "2024-04-01 11:35:00"
    },
    {
      "status": "completed",
      "event_datetime": "2024-04-01 16:00:00",
      "selected_agent": {
        "AGENT-TYPE": "manager",
        "AGENT-KEY": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
        "AGENT-USER": "manager@example.com"
      }
    }
  ]
}

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 identifying name.
`assignment_number`	string	Sequential assignment batch number.
`assignment_date`	string	Assignment date in `YYYY-MM-DD` format.
`status`	string	Current batch status. See the status enumerators for all possible values.
`assignment_term_key`	string	Assignment Term key (UUID). Available after term generation.
`assignment_total_value`	number	Total assignment value in BRL. Available after approval. May not be present if not yet calculated.
`assignment_irr`	number	Internal rate of return (IRR) of the batch. May not be present if not yet calculated.
`assignment_configuration`	object	Complete assignment configuration data. See table below.
`disbursement`	object \| null	Disbursement account data. `null` when not yet configured.
`assignor_discounts`	array	List of assignor discounts. Present only when discounts are configured. See table below.
`status_events`	array	Batch status transition history. See table below.

`assignment_configuration` attributes

Field	Type	Description
`assignment_configuration_key`	string	Configuration key (UUID).
`validation_configuration_key`	string	Validation configuration key (UUID).
`assignment_configuration_name`	string	Assignment configuration name.
`assignment_contract_key`	string	Assignment contract key (UUID).
`registry_type`	string	Asset registration type (e.g., `internal_registry`, `external_registry`).
`asset_type`	string	Asset type accepted in this configuration (e.g., `ccb`, `duplicata_mercantil`, `duplicata_servico`).
`assignment_configuration_type`	string	Assignment configuration type (e.g., `standard`).
`consultant_decision_type`	string	Consultant decision type (e.g., `manual_approval`, `auto_approval`).
`asset_fees`	object \| null	Asset fee configuration, when applicable.
`assignment_reports`	object \| null	Assignment report configuration, when applicable.
`fund_class`	object	Assignee fund data. See table below.
`assignor`	object	Assignor data. See table below.
`consultant`	object	Consultant data. Present when the configuration has a linked consultant. See table below.
`originator_bonds`	array	List of originators linked to the configuration. See table below.
`webhook_configuration_bonds`	array	List of linked webhook configurations. See table below.

`fund_class` attributes

Field	Type	Description
`fund_class_key`	string	Unique fund key (UUID).
`name`	string	Fund name.
`document_number`	string	Fund CNPJ.
`accounting_date`	string	Fund's current accounting date in `YYYY-MM-DD` format.
`manager`	object	Fund manager data. See table below.

`manager` attributes

Field	Type	Description
`manager_key`	string	Unique manager key (UUID).
`document_number`	string	Manager CNPJ.
`manager_name`	string	Manager name.

`assignor` attributes

Field	Type	Description
`assignor_key`	string	Unique assignor key (UUID).
`document_number`	string	Assignor CPF/CNPJ.
`name`	string	Assignor name.

`consultant` attributes

Field	Type	Description
`consultant_key`	string	Unique consultant key (UUID).
`document_number`	string	Consultant CNPJ.
`name`	string	Consultant name.

`originator_bonds` attributes

Field	Type	Description
`originator`	object	Originator data.
`originator.originator_key`	string	Unique originator key (UUID).
`originator.document_number`	string	Originator CNPJ.
`originator.name`	string	Originator name.

`webhook_configuration_bonds` attributes

Field	Type	Description
`webhook_configuration_bond`	object	Webhook configuration data.
`webhook_configuration_bond.webhook_configuration_key`	string	Unique webhook configuration key (UUID).
`webhook_configuration_bond.agent_type`	string	Type of agent that will receive the webhook (e.g., `assignor`, `manager`, `consultant`).
`webhook_configuration_bond.agent_key`	string	Key of the linked agent.
`signature_key`	string	Signature key for webhook validation (UUID).
`webhook_url`	string	Webhook destination URL.

`assignor_discounts` attributes

Field	Type	Description
`assignor_discount_key`	string	Unique discount key (UUID).
`assignor_discount_type`	string	Assignor discount type (e.g., `flat_rate`).
`status`	string	Discount status (e.g., `approved`, `pending`).
`total_value`	number	Total discount value in BRL.
`description`	string	Discount description.

`status_events` attributes

Field	Type	Description
`status`	string	Event status.
`event_datetime`	string	Event date and time in `YYYY-MM-DD HH:MM:SS` format.
`selected_agent`	object	Data of the agent responsible for the transition. Present only when the transition was made by an identified agent.

Request​

Path params​

Response​

Response attributes​

assignment_configuration attributes​

fund_class attributes​

manager attributes​

assignor attributes​

consultant attributes​

originator_bonds attributes​

webhook_configuration_bonds attributes​

assignor_discounts attributes​

status_events attributes​