Assignment Batch Creation

This is the first step of the credit rights assignment flow. Creating the batch (assignment) reserves a grouping container where the assets to be assigned to the fund will be inserted in subsequent steps.

Prerequisites

Before creating a batch, you need:

• The fund_class_key — unique key of the assignee fund.
• The assignment_configuration_key — unique key of the assignment configuration, obtained during Assignor Onboarding.

These two keys compose the endpoints used in all endpoints of this API:

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

For more details about the complete flow, see the Credit Rights Assignment Manual.

Request

ENDPOINT

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

METHOD

POST

Request Body

{
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "assignment_date": "2024-04-01"
}

Body attributes

Field	Type	Required	Description
external_id	string	required	Unique identification key for this batch in the integrating partner's system. Must be unique — the system will not allow creating two batches with the same identifier. Maximum 50 characters.
assignment_date	string	optional	Assignment date in YYYY-MM-DD format. When provided, must match the fund's accounting date (accounting_date). If not provided, the current accounting date will be used.

Response

STATUS

201

Response Body

{
    "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "status": "pending_assets_insertion"
}

Response attributes

Field	Type	Description
assignment_key	string	Unique batch identifier generated by QI Tech (UUID).
external_id	string	The same external key provided in the request.
status	string	Initial batch status. Always returns pending_assets_insertion, indicating the batch is ready to receive assets.

Possible errors

STATUS

404

Assignment configuration not found

The combination of fund_class_key and assignment_configuration_key provided does not match any assignment configuration. Verify the keys are correct and that the assignment contract has already been onboarded at the Assignor Onboarding step.

{
  "title": "AssignmentConfiguration was not found",
  "description": "AssignmentConfiguration was not found",
  "translation": "Configuração de cessão não foi encontrada",
  "code": "TRC000016"
}

STATUS

400

Invalid assignment date

The date provided in the assignment_date field does not match the fund's current accounting date. Each fund has a current accounting date, and the assignment date must equal that date. Check the fund's current accounting date or omit the assignment_date field to let the system use it automatically.

{
  "title": "Invalid assignment date.",
  "description": "Given assignment date is different from fund accounting date.",
  "translation": "Data de cessão fornecida diferente da data do fundo.",
  "code": "TRC000083"
}

STATUS

400

Duplicate external_id

A batch with the provided external_id already exists. Each batch must have a unique identifier in the system. Generate a new external_id and try again.

{
  "title": "Already Exists This External Id",
  "description": "Already Exists This External Id",
  "translation": "Já existe lote com esse external_id",
  "code": "TRC000041"
}

Next steps

After creating the batch, the flow continues with:

1. Asset insertion — add the assets (CCBs, invoices, etc.) to be assigned to the fund.
2. Document submission — submit the required documentation for each asset approved in eligibility.
3. Insertion closure — signal that all assets have been inserted so that the batch proceeds to eligibility analysis.