Recuperação do Lote de Cessão

Recupera os detalhes completos de um lote de cessão específico, incluindo informações da configuração, status atual, histórico de eventos, dados de desembolso e valores financeiros.

Quando utilizar

Use este endpoint para consultar o estado atual de um lote a qualquer momento do fluxo — por exemplo, para verificar se o lote já passou pela elegibilidade, se o gestor já aprovou, ou se o pagamento foi realizado.

Request

ENDPOINT

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

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
fund_class_key	string	Chave única do fundo (UUID).
assignment_configuration_key	string	Chave da configuração de cessão (UUID).
assignment_external_id	string	O external_id informado na criação do lote.

Response

STATUS

200

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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "validation_configuration_key": "v1w2x3y4-z5a6-7890-abcd-ef1234567890",
    "assignment_configuration_name": "Config CCB Fundo 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": "Fundo Alpha FIDC",
      "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": "Gestora Exemplo S.A."
      }
    },
    "assignor": {
      "assignor_key": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
      "document_number": "98.765.432/0001-10",
      "name": "Cedente Exemplo Ltda"
    },
    "consultant": {
      "consultant_key": "g1h2i3j4-k5l6-7890-abcd-ef1234567890",
      "document_number": "55.666.777/0001-88",
      "name": "Consultoria Exemplo Ltda"
    },
    "originator_bonds": [
      {
        "originator": {
          "originator_key": "h1i2j3k4-l5m6-7890-abcd-ef1234567890",
          "document_number": "22.333.444/0001-55",
          "name": "Originadora Exemplo 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": "Taxa de administração"
    }
  ],
  "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": "gestor@exemplo.com"
      }
    }
  ]
}

Atributos da resposta

Campo	Tipo	Descrição
assignment_key	string	Identificador único do lote gerado pela QI Tech (UUID).
external_id	string	Chave externa fornecida pelo parceiro na criação.
name	string	Nome identificador da cessão.
assignment_number	string	Número sequencial do lote de cessão.
assignment_date	string	Data da cessão no formato YYYY-MM-DD.
status	string	Status atual do lote. Consulte os enumeradores de status para todos os valores possíveis.
assignment_term_key	string	Chave do Termo de Cessão (UUID). Disponível após a geração do termo.
assignment_total_value	number	Valor total da cessão em reais. Disponível após a aprovação. Pode não estar presente se ainda não foi calculado.
assignment_irr	number	Taxa interna de retorno (TIR) do lote. Pode não estar presente se ainda não foi calculada.
assignment_configuration	object	Dados completos da configuração de cessão. Veja tabela abaixo.
disbursement	object | null	Dados da conta de desembolso. null quando ainda não configurada.
assignor_discounts	array	Lista de descontos do cedente. Presente apenas quando existem descontos configurados. Veja tabela abaixo.
status_events	array	Histórico de transições de status do lote. Veja tabela abaixo.

Atributos de assignment_configuration

Campo	Tipo	Descrição
assignment_configuration_key	string	Chave da configuração (UUID).
validation_configuration_key	string	Chave da configuração de validação (UUID).
assignment_configuration_name	string	Nome da configuração de cessão.
assignment_contract_key	string	Chave do contrato de cessão (UUID).
registry_type	string	Tipo de registro dos ativos (ex: internal_registry, external_registry).
asset_type	string	Tipo de ativo aceito nesta configuração (ex: ccb, duplicata_mercantil, duplicata_servico).
assignment_configuration_type	string	Tipo da configuração de cessão (ex: standard).
consultant_decision_type	string	Tipo de decisão do consultor (ex: manual_approval, auto_approval).
asset_fees	object | null	Configuração de taxas dos ativos, quando aplicável.
assignment_reports	object | null	Configuração de relatórios da cessão, quando aplicável.
fund_class	object	Dados do fundo cessionário. Veja tabela abaixo.
assignor	object	Dados do cedente. Veja tabela abaixo.
consultant	object	Dados do consultor. Presente quando a configuração possui consultor vinculado. Veja tabela abaixo.
originator_bonds	array	Lista de originadores vinculados à configuração. Veja tabela abaixo.
webhook_configuration_bonds	array	Lista de configurações de webhook vinculadas. Veja tabela abaixo.

Atributos de fund_class

Campo	Tipo	Descrição
fund_class_key	string	Chave única do fundo (UUID).
name	string	Nome do fundo.
document_number	string	CNPJ do fundo.
accounting_date	string	Data contábil vigente do fundo no formato YYYY-MM-DD.
manager	object	Dados do gestor do fundo. Veja tabela abaixo.

Atributos de manager

Campo	Tipo	Descrição
manager_key	string	Chave única do gestor (UUID).
document_number	string	CNPJ do gestor.
manager_name	string	Nome do gestor.

Atributos de assignor

Campo	Tipo	Descrição
assignor_key	string	Chave única do cedente (UUID).
document_number	string	CPF/CNPJ do cedente.
name	string	Nome do cedente.

Atributos de consultant

Campo	Tipo	Descrição
consultant_key	string	Chave única do consultor (UUID).
document_number	string	CNPJ do consultor.
name	string	Nome do consultor.

Atributos de originator_bonds

Campo	Tipo	Descrição
originator	object	Dados do originador.
originator.originator_key	string	Chave única do originador (UUID).
originator.document_number	string	CNPJ do originador.
originator.name	string	Nome do originador.

Atributos de webhook_configuration_bonds

Campo	Tipo	Descrição
webhook_configuration_bond	object	Dados da configuração de webhook.
webhook_configuration_bond.webhook_configuration_key	string	Chave única da configuração de webhook (UUID).
webhook_configuration_bond.agent_type	string	Tipo do agente que receberá o webhook (ex: assignor, manager, consultant).
webhook_configuration_bond.agent_key	string	Chave do agente vinculado.
signature_key	string	Chave de assinatura para validação do webhook (UUID).
webhook_url	string	URL de destino do webhook.

Atributos de assignor_discounts

Campo	Tipo	Descrição
assignor_discount_key	string	Chave única do desconto (UUID).
assignor_discount_type	string	Tipo de desconto do cedente (ex: flat_rate).
status	string	Status do desconto (ex: approved, pending).
total_value	number	Valor total do desconto em reais.
description	string	Descrição do desconto.

Atributos de status_events

Campo	Tipo	Descrição
status	string	Status do evento.
event_datetime	string	Data e hora do evento no formato YYYY-MM-DD HH:MM:SS.
selected_agent	object	Dados do agente responsável pela transição. Presente apenas quando a transição foi feita por um agente identificado.