# QI Tech — Investment-as-a-Service › Passivo Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 34 página(s). Índice: - Recuperando Informações da Posição do Investidor (/documentation/iaas/investidor/informacoes_posicao_investidor) - Listagem de Solicitações de Amortização (/documentation/iaas/passivo/amortizacao/listagem) - Consulta paginada de Aplicação Financeira (/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras) - Consulta paginada de Fechamento das Aplicações Financeiras (/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_fechamento_das_aplicacoes_financeiras) - Consultar Aplicação Financeira por chave (/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave) - Criar Aplicação Financeira (/documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira) - Aprovação manual de bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/aprovar_bloqueio_pendente_aprovacao) - Consultar bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas) - Consultar bloqueio de cotas de um investidor (/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas_de_um_investidor) - Enviar Documento da Garantia (/documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_da_garantia) - Enviar Documento do Ativo (/documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_do_ativo) - Execução de garantia (/documentation/iaas/passivo/bloqueio_de_cotas/execucao_de_garantia) - Reduzir bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/reduzir_bloqueio_de_cotas) - Solicitar bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas) - Webhook de bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/webhooks_de_bloqueio_de_cota) - Consulta paginada de investidores por classe de fundo (/documentation/iaas/passivo/consultas/consulta_investidores_classe_fundo) - Consulta paginada de posições de cotistas por classe de fundo (/documentation/iaas/passivo/consultas/consulta_posicoes_cotistas_classe_fundo) - Consulta paginada dos fechamentos de uma série de emissão (/documentation/iaas/passivo/consultas/consultar_fechamentos_serie_de_emissao) - Consulta paginada do Mapa de Evolução de Cotas (/documentation/iaas/passivo/consultas/consultar_mapa_de_evolucao_de_cotas) - Consulta paginada de Séries de Emissão (/documentation/iaas/passivo/consultas/consultar_todas_series_de_emissao) - Consulta paginada de Fundos (/documentation/iaas/passivo/consultas/consultar_todos_fundos) - Enviar Boletim de Subscrição Assinado (/documentation/iaas/passivo/controle_de_oferta/enviar_boletim_de_subscricao_assinado) - Recuperando Informações sobre Boletim de Subscrição (/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao) - Recuperando Informações sobre as Ofertas (/documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas) - Solicitar Boletim de Subscrição (/documentation/iaas/passivo/controle_de_oferta/solicitar_boletim_de_subscricao) - Recuperando Cotas Públicas (/documentation/iaas/passivo/fundos/cotas_publicas) - Introdução (/documentation/iaas/passivo/inicio) - Consulta paginada de negociações em mercado secundário (/documentation/iaas/passivo/mercado_secundario/consulta_negociacoes_mercado_secundario) - Consultar Pedido de Resgate por chave (/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave) - Consulta paginada de pedidos de resgate por classe de fundo (/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo) - Consulta paginada de pedidos de resgate por investidor (/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor) - Criar Pedido de Resgate (/documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate) - Enviar Termo de Adesão Assinado (/documentation/iaas/passivo/termo_de_adesao/enviar_termo_de_adesao_assinado) - Solicitar Termo de Adesão (/documentation/iaas/passivo/termo_de_adesao/solicitar_termo_de_adesao) --- # Recuperando Informações da Posição do Investidor URL: /documentation/iaas/investidor/informacoes_posicao_investidor Retorna, de forma paginada, a posição do investidor em cada série de emissão em que ele tem cotas. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | -------------------------------------------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ### Request ENDPOINT /quota/investor/INVESTOR_KEY/investor_positions MÉTODO GET ### Query Params | Parâmetro | Tipo | Descrição | |------------------------------|---------|--------------------------------------------------------------------------------------| | `issuance_serie_key` | string | Filtra pela série de emissão | | `fund_class_document_number` | string | Filtra pelo CNPJ da classe de fundo | | `only_active_funds` | boolean | `true` retorna só as séries em que o investidor tem cotas (quantidade maior que zero). Default: `false` | | `number_of_quotas_str` | boolean | `true` devolve as quantidades de cotas como string, sem perda de precisão. Default: `false` | | `page` | integer | Página, a partir de `0`. Default: `0` | | `limit` | integer | Itens por página. Default: `20`; máximo: `100` | Percorra as páginas incrementando `page` enquanto `is_last_page` for `false`. ### Responses STATUS 200 Caso 01: Investidor com Posição em somente uma série de COTA ÚNICA ```json { "data": [ { "investor_position_key":"UUID", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "33.444.555/0001-81", "name": "SAMPLE DISTRIBUTOR NAME", "account_data": { "owner": { "name": "SAMPLE DISTRIBUTOR NAME", "document_number": "33.444.555/0001-81" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" } }, "investor_key": "UUID", "document_number": "969.698.790-03", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person / fund_class", "account_data": { "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "investor_sub_type": "person / financial_institution" }, "number_of_quotas": 1000.0, "quota_value": 1.05, "issuance_serie": { "name": "1", "cetip_code": "0000000UN1", "start_date": "YYYY-MM-DD", "maturity_date": "YYYY-MM-DD", "original_quota_value": 0.00000000000000, "remuneration_type": "residual", "investment_category": "fidc / multi_market", "condominum_type": "open_ended / close_ended", "tax_classification": "short_term / long_term", "investment_restriction_type": "just_professional", "issuance_serie_key": "UUID", "accounting_date": "YYYY-MM-DD", "sub_class": { "name": "COTA ÚNICA", "sub_class_key": "UUID", "subordination_level": 0, "fund_class": { "name": "SAMPLE FUND CLASS NAME", "fund_class_key": "UUID", "document_number": "44.555.666/0001-81" } } } } ], "limit": 20, "page": 0, "is_last_page": true } ``` Caso 02: Investidor com Posição em somente uma série de COTA SÊNIOR ```json { "data": [ { "investor_position_key":"UUID", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "33.444.555/0001-81", "name": "SAMPLE DISTRIBUTOR NAME", "account_data": { "owner": { "name": "SAMPLE DISTRIBUTOR NAME", "document_number": "33.444.555/0001-81" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" } }, "investor_key": "UUID", "document_number": "969.698.790-03", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person / fund_class", "account_data": { "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "investor_sub_type": "person / financial_institution" }, "number_of_quotas": 1000.0, "quota_value": 1.05, "issuance_serie": { "name": "1", "cetip_code": "0000000SN1", "start_date": "YYYY-MM-DD", "maturity_date": "YYYY-MM-DD", "original_quota_value": 0.00000000000000, "remuneration_type": "yield_curve", "interest_rate_type": "post_fixed", "pre_fixed": { "calendar_base": "workdays / calendar_360 / calendar_365", "monthly_rate": 0.00000000000000 }, "post_fixed": { "calendar_base": "workdays / calendar_360 / calendar_365", "indexer": "di / ipca", "rate": 1, "lag": {"reference": "daily / monthly", "amount": 1} }, "investment_category": "fidc / multi_market", "condominum_type": "open_ended / close_ended", "tax_classification": "short_term / long_term", "investment_restriction_type": "just_professional", "issuance_serie_key": "UUID", "accounting_date": "YYYY-MM-DD", "sub_class": { "name": "COTA SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "name": "SAMPLE FUND CLASS NAME", "fund_class_key": "UUID", "document_number": "44.555.666/0001-81" } } } } ], "limit": 20, "page": 0, "is_last_page": true } ``` Caso 03: Investidor com Posição em duas séries, uma COTA SÊNIOR e uma COTA SUBORDINADA ```json { "data":[ { "investor_position_key":"UUID", "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"33.444.555/0001-81", "name":"SAMPLE DISTRIBUTOR NAME", "account_data":{ "owner":{ "name":"SAMPLE DISTRIBUTOR NAME", "document_number":"33.444.555/0001-81" }, "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" } }, "investor_key":"UUID", "document_number":"969.698.790-03", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person / fund_class", "account_data":{ "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" }, "investor_sub_type":"person / financial_institution" }, "number_of_quotas": 1000.0, "quota_value": 1.05, "issuance_serie":{ "name":"1", "cetip_code":"0000000SN1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"yield_curve", "interest_rate_type":"post_fixed", "pre_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "monthly_rate":0.00000000000000 }, "post_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "indexer":"di / ipca", "rate":1, "lag":{ "reference":"daily / monthly", "amount":1 } }, "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"44.555.666/0001-81" } } } }, { "investor_position_key":"UUID", "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"33.444.555/0001-81", "name":"SAMPLE DISTRIBUTOR NAME", "account_data":{ "owner":{ "name":"SAMPLE DISTRIBUTOR NAME", "document_number":"33.444.555/0001-81" }, "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" } }, "investor_key":"UUID", "document_number":"969.698.790-03", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person / fund_class", "account_data":{ "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" }, "investor_sub_type":"person / financial_institution" }, "number_of_quotas": 1000.0, "quota_value": 1.05, "issuance_serie":{ "name":"1", "cetip_code":"0000000JR1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"residual", "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SUBORDINADA", "sub_class_key":"UUID", "subordination_level":0, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"44.555.666/0001-81" } } } } ], "limit": 20, "page":0, "is_last_page":true } ``` ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Investor Position](#investor_position)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Investor Position {#investor_position} | Campo | Tipo | Descrição | |--------------------------|--------|-------------------------------------------------------| | `investor` | JSON | Objeto de **[Investor](#investor)** | | `number_of_quotas` | float | Número de cotas do investidor na série | | `number_of_quotas_str` | string | O mesmo valor, como string. Só vem com `number_of_quotas_str=true` | | `quota_value` | float | Valor da cota no fechamento mais recente da série. Ausente se a série ainda não tem fechamento | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance_serie)** | | `investor_position_key` | string | Chave única de identificação da posição do investidor | ### Investor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do investidor | até 255 | | `investor_key` | string | Chave única de identificação do investidor | 36 | | `document_number` | string | CPF/CNPJ do investidor | 14 ou 18 | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | até 50 | | `investor_sub_type` | string | Default / Instituição Financeira | até 50 | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | - | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Distributor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do distribuidor | até 255 | | `distributor_key` | string | Chave única de identificação do distribuidor | - | | `document_number` | string | CPF/CNPJ do distribuidor | 14 ou 18 | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Account Data {#account_data} | Campo | Tipo | Descrição | |------------------------------|----------|-----------------------------------------------------------------------------| | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro da instituição financeira | ### Issuance Serie {#issuance_serie} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da série de emissão | até 255 | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | 36 | | `cetip_code` | string | Código da série de emissão como ativo na CETIP | 10 | | `start_date` | string | Data de início da série de emissão | 10 | | `maturity_date` | string | Data de vencimento da série de emissão | 10 | | `original_quota_value` | float | Valor de cota original | - | | `remuneration_type` | string | Curva de rendimento / Residual | até 50 | | `investment_category` | string | FIDC / Multimercado | até 50 | | `condominum_type` | string | Aberto / Fechado | até 50 | | `tax_classification` | string | Curto prazo / Longo prazo | até 50 | | `investment_restriction_type` | string | Sem restrição / Qualificado / Profissional | até 50 | | `accounting_date` | string | Data contábil da série de emissão | 10 | | `sub_class` | JSON | Objeto de **[Sub Class](#sub_class)** | - | ### Sub Class {#sub_class} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da sub classe | até 255 | | `sub_class_key` | string | Chave única de identificação da sub classe | 36 | | `subordination_level` | int | Nível de subordinação da sub classe | - | | `fund_class` | JSON | Objeto de **[Fund Class](#fund_class)** | - | ### Fund Class {#fund_class} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da classe de fundo | até 255 | | `fund_class_key` | string | Chave única de identificação da classe de fundo | 36 | | `document_number` | string | CNPJ da classe de fundo | - | ## Erros | Status | Código | Quando acontece | | ------ | ------ | --------------- | | 400 | — | `limit` acima de 100 ou `page` negativo | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Listagem de Solicitações de Amortização URL: /documentation/iaas/passivo/amortizacao/listagem Endpoint de consulta paginada que retorna as solicitações de amortização de uma determinada classe de fundo. A resposta inclui, para cada solicitação, os dados financeiros calculados, o histórico de status, as amortizações por investidor e os dados da série de emissão vinculada. :::info Filtros de retorno Por padrão, todos os sub-objetos (`issuance_serie`, `investor_amortizations` e `status_events`) são retornados. Utilize os query params `dto_filters_*` para omitir campos e reduzir o tamanho da resposta. ::: :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/amortization_requests MÉTODO GET ### Path params | Parâmetro | Tipo | Descrição | |---|---|---| | `fund_class_key` | string | Chave única da classe de fundo (UUID). | ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em 0). Padrão: `0`. | | `limit` | integer | opcional | Quantidade de registros por página. Padrão: `20`. Máximo: `100`. | | `status` | array de strings | opcional | Um ou mais status da solicitação (veja [Enumeradores de `status`](#enumeradores-de-status)). Repita o parâmetro para enviar mais de um. | | `issuance_serie_key` | string | opcional | Filtra por série de emissão. | | `quotation_date` | string | opcional | Filtra pela data de cotização (`YYYY-MM-DD`). | | `dto_filters_issuance_serie` | string | opcional | Envie `true` para omitir o objeto `issuance_serie` de cada item. | | `dto_filters_investor_amortizations` | string | opcional | Envie `true` para omitir o array `investor_amortizations` de cada item. | | `dto_filters_status_events` | string | opcional | Envie `true` para omitir o array `status_events` de cada item. | :::caution Atenção Os parâmetros `dto_filters_*` omitem o campo com **qualquer** valor não vazio — inclusive `false`. Para receber o campo, não envie o parâmetro. ::: Os resultados vêm da data de cotização mais recente para a mais antiga. ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/amortization_requests?page=0&limit=20 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "amortization_request_key": "3571e292-3a83-4011-904d-20ee963022ef", "type": "scheduled_amortization", "regime_type": "issuance_serie_principal_percentage", "quotation_date": "2026-06-05", "principal_percentage": 0.5, "financial_application_yield_percentage": 0.12, "gross_value": 10000.0, "result_quota_value": 1.05, "amortization_value": 5000.0, "net_value": 4750.0, "quota_percentage": 0.5, "status": "done", "status_events": [ { "status": "created", "event_datetime": "2026-06-01T10:00:00.000Z" }, { "status": "done", "event_datetime": "2026-06-05T14:30:00.000Z" } ], "investor_amortizations": [ { "investor_amortization_key": "f1e2d3c4-b5a6-7890-fedc-ba9876543210", "investor": { "investor_key": "aaaa1111-bbbb-2222-cccc-dddd33334444", "name": "Investidor Exemplo S.A.", "person_type": "legal_person", "document_number": "11.222.333/0001-81", "distributor": { "distributor_key": "dddd4444-eeee-5555-ffff-aaaa66667777", "name": "Distribuidora Exemplo", "document_number": "22.333.444/0001-81", "account_data": { "bank": "341", "agency": "1234", "account": "56789-0" } } }, "status": "done", "net_value": 4750.0, "ir_value": 200.0, "iof_value": 50.0, "ir_compensation": 0.0, "iof_compensation": 0.0, "total_value": 5000.0, "payment_method": "regular", "payment_date": "2026-06-06", "status_events": [ { "status": "created", "event_datetime": "2026-06-01T10:00:00.000Z" }, { "status": "done", "event_datetime": "2026-06-06T09:00:00.000Z" } ], "amortizations": [ { "financial_application_key": "fa111111-2222-3333-4444-555566667777", "amortization_key": "am888888-9999-aaaa-bbbb-ccccddddeeee", "status": "settled", "principal_reduction": 2500.0, "acquisition_cost_reduction": 0.0, "yield_value": 300.0, "total_value": 2800.0, "ir_value": 100.0, "iof_value": 25.0, "taxable_yield_value": 300.0 } ], "payments": [ { "payment_key": "pp000000-1111-2222-3333-444455556666", "origin_key": "f1e2d3c4-b5a6-7890-fedc-ba9876543210", "total_value": 4750.0, "target_account": { "bank": "341", "agency": "1234", "account": "56789-0" }, "payment_type": "amortization_payment.investor", "payment_date": "2026-06-06", "status": "paid", "status_events": [ { "status": "paid", "event_datetime": "2026-06-06T09:15:00.000Z" } ] } ] } ], "issuance_serie": { "issuance_serie_key": "is111111-2222-3333-4444-555566667777", "name": "Série A - Cota Sênior", "serie": 1, "original_quota_value": 1.0, "current_quota_value": 1.05, "current_number_of_quotas": 1000000.0, "current_net_worth": 1050000.0, "current_principal_value": 1000000.0, "performance_fee_current_value": 0.0, "remuneration_type": "yield_curve", "status": "active", "internal_code": "SR-001", "sub_class": { "sub_class_key": "sc222222-3333-4444-5555-666677778888", "name": "Classe Sênior", "subordination_level": 1, "fund_class": { "fund_class_key": "fc333333-4444-5555-6666-777788889999", "name": "Fundo de Investimento em Direitos Creditórios Exemplo", "short_name": "FIDC Exemplo", "document_number": "33.444.555/0001-81", "accounting_date": "2026-06-09", "sub_type": "regular", "tax_classification": "long_term", "condominum_type": "closed", "investment_category": "credit_rights", "prevent_payment": false, "manager": { "manager_key": "mg444444-5555-6666-7777-888899990000", "name": "Gestora Exemplo DTVM", "document_number": "44.555.666/0001-81" } } } } } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de solicitações de amortização. Veja tabela abaixo. | | `page` | integer | Número da página atual. | | `limit` | integer | Quantidade de registros por página. | | `is_last_page` | boolean | Indica se esta é a última página de resultados. | #### Atributos de cada solicitação (objetos dentro de `data`) | Campo | Tipo | Descrição | |---|---|---| | `amortization_request_key` | string | Identificador único da solicitação (UUID). | | `type` | string | Tipo da amortização. Consulte os [enumeradores de tipo](#enumeradores-de-type) abaixo. | | `regime_type` | string | Regime de cálculo da amortização. Consulte os [enumeradores de regime](#enumeradores-de-regime_type) abaixo. | | `quotation_date` | string | Data de cotização no formato `YYYY-MM-DD`. | | `principal_percentage` | number | Percentual do principal a ser amortizado. Presente conforme o `regime_type`. | | `financial_application_yield_percentage` | number | Percentual de rendimento da aplicação financeira. Presente conforme o `regime_type`. | | `gross_value` | number | Valor bruto total da amortização em reais. | | `result_quota_value` | number | Valor da cota resultante após a amortização. | | `amortization_value` | number | Valor total a ser amortizado em reais. | | `net_value` | number | Valor líquido total após impostos em reais. | | `quota_percentage` | number | Percentual de cotas resgatadas. Presente conforme o `regime_type`. | | `status` | string | Status atual da solicitação. Consulte os [enumeradores de status](#enumeradores-de-status) abaixo. | | `status_events` | array | Histórico de transições de status. Omitido se `dto_filters_status_events=true`. Veja tabela abaixo. | | `investor_amortizations` | array | Lista de amortizações individuais por investidor. Omitido se `dto_filters_investor_amortizations=true`. Veja tabela abaixo. | | `issuance_serie` | object | Dados da série de emissão vinculada. Omitido se `dto_filters_issuance_serie=true`. Veja tabela abaixo. | #### Atributos de `status_events` | Campo | Tipo | Descrição | |---|---|---| | `status` | string | Status do evento. | | `event_datetime` | string | Data e hora do evento no formato ISO 8601 (ex: `2026-06-01T10:00:00.000Z`). | #### Atributos de `investor_amortizations` | Campo | Tipo | Descrição | |---|---|---| | `investor_amortization_key` | string | Identificador único da amortização do investidor (UUID). | | `investor` | object | Dados do investidor. Veja tabela abaixo. | | `status` | string | Status da amortização do investidor. Consulte os [enumeradores de status do investidor](#enumeradores-de-status-do-investor_amortization) abaixo. | | `net_value` | number | Valor líquido a pagar ao investidor em reais. | | `ir_value` | number | Valor de IR retido em reais. | | `iof_value` | number | Valor de IOF retido em reais. | | `ir_compensation` | number | Compensação de IR em reais. | | `iof_compensation` | number | Compensação de IOF em reais. | | `total_value` | number | Valor total bruto em reais. Presente após o cálculo. | | `payment_method` | string | Método de pagamento. Consulte os [enumeradores de método de pagamento](#enumeradores-de-payment_method) abaixo. | | `payment_date` | string | Data prevista do pagamento no formato `YYYY-MM-DD`. | | `status_events` | array | Histórico de transições de status do investidor. Mesma estrutura de `status_events` da solicitação. | | `amortizations` | array | Detalhamento por aplicação financeira. Veja tabela abaixo. | | `payments` | array | Lista de pagamentos gerados. Veja tabela abaixo. | #### Atributos de `investor` | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Chave única do investidor (UUID). | | `name` | string | Nome do investidor. | | `person_type` | string | Tipo de pessoa (`natural_person`, `legal_person` ou `nominee`). | | `document_number` | string | CPF ou CNPJ do investidor. Presente quando disponível. | | `external_id` | string | Identificador externo do investidor. Presente quando informado. | | `external_distribution_key` | string | Chave de distribuição externa. Presente quando informada. | | `short_name` | string | Nome abreviado. Presente quando informado. | | `sub_type` | string | Subtipo do investidor. Presente quando informado. | | `distributor` | object | Dados da distribuidora vinculada. Veja tabela abaixo. | #### Atributos de `distributor` | Campo | Tipo | Descrição | |---|---|---| | `distributor_key` | string | Chave única da distribuidora (UUID). | | `name` | string | Nome da distribuidora. | | `document_number` | string | CNPJ da distribuidora. | | `account_data` | object | Dados bancários da distribuidora. | #### Atributos de `amortizations` {#amortizations} | Campo | Tipo | Descrição | |---|---|---| | `financial_application_key` | string | Chave da aplicação financeira (UUID). | | `amortization_key` | string | Chave única da amortização (UUID). | | `status` | string | Status da amortização. | | `principal_reduction` | number | Redução de principal em reais. | | `acquisition_cost_reduction` | number | Redução de custo de aquisição em reais. | | `yield_value` | number | Valor de rendimento em reais. Presente quando calculado. | | `total_value` | number | Valor total em reais. Presente quando calculado. | | `ir_value` | number | Valor de IR em reais. Presente quando calculado. | | `iof_value` | number | Valor de IOF em reais. Presente quando calculado. | | `taxable_yield_value` | number | Valor de rendimento tributável em reais. Presente quando calculado. | #### Atributos de `payments` | Campo | Tipo | Descrição | |---|---|---| | `payment_key` | string | Chave única do pagamento (UUID). | | `origin_key` | string | Chave da origem do pagamento (UUID). | | `total_value` | number | Valor total do pagamento em reais. | | `target_account` | object | Dados da conta de destino. | | `description` | string | Descrição do pagamento. Presente quando informada. | | `payment_type` | string | Tipo do pagamento. Consulte os [enumeradores de tipo de pagamento](#enumeradores-de-payment_type) abaixo. | | `payment_date` | string | Data do pagamento no formato `YYYY-MM-DD`. | | `status` | string | Status do pagamento. Consulte os [enumeradores de status do pagamento](#enumeradores-de-status-do-payment) abaixo. | | `deleted_at` | string | Data e hora de exclusão no formato ISO 8601. Presente apenas quando o pagamento foi cancelado. | | `status_events` | array | Histórico de transições de status do pagamento. Mesma estrutura de `status_events` da solicitação. | #### Atributos de `issuance_serie` | Campo | Tipo | Descrição | |---|---|---| | `issuance_serie_key` | string | Chave única da série de emissão (UUID). | | `name` | string | Nome da série de emissão. | | `serie` | integer | Número da série. | | `original_quota_value` | number | Valor original da cota em reais. | | `current_quota_value` | number | Valor atual da cota em reais (calculado como `current_net_worth / current_number_of_quotas`). | | `current_number_of_quotas` | number | Quantidade atual de cotas em circulação. | | `current_net_worth` | number | Patrimônio líquido atual em reais. | | `current_principal_value` | number | Valor de principal atual em reais. | | `performance_fee_current_value` | number | Valor atual de taxa de performance em reais. | | `remuneration_type` | string | Tipo de remuneração da série. | | `status` | string | Status da série de emissão. | | `internal_code` | string | Código interno da série. | | `pre_fixed` | number | Taxa pré-fixada. Presente quando aplicável. | | `post_fixed` | object | Dados do indexador pós-fixado. Presente quando aplicável. | | `interest_rate_type` | string | Tipo de taxa de juros. Presente quando aplicável. | | `isin_code` | string | Código ISIN da série. Presente quando informado. | | `external_id` | string | Identificador externo. Presente quando informado. | | `specific_interest_rate_data` | object | Dados específicos de taxa de juros. Presente quando aplicável. | | `sub_class` | object | Dados da subclasse vinculada. Veja tabela abaixo. | #### Atributos de `sub_class` | Campo | Tipo | Descrição | |---|---|---| | `sub_class_key` | string | Chave única da subclasse (UUID). | | `name` | string | Nome da subclasse. | | `subordination_level` | integer | Nível de subordinação da subclasse. | | `fund_class` | object | Dados da classe de fundo. Veja tabela abaixo. | #### Atributos de `fund_class` | Campo | Tipo | Descrição | |---|---|---| | `fund_class_key` | string | Chave única da classe de fundo (UUID). | | `name` | string | Nome do fundo. | | `short_name` | string | Nome abreviado do fundo. | | `document_number` | string | CNPJ do fundo. | | `accounting_date` | string | Data contábil vigente no formato `YYYY-MM-DD`. | | `sub_type` | string | Subtipo do fundo (`regular` ou `cash`). | | `tax_classification` | string | Classificação tributária do fundo. | | `condominum_type` | string | Tipo de condomínio do fundo. | | `investment_category` | string | Categoria de investimento. | | `prevent_payment` | boolean | Indica se pagamentos estão bloqueados para o fundo. | | `manager` | object | Dados do gestor do fundo. | | `administrator` | object | Dados do administrador. Presente quando informado. | | `integralization_account_key` | string | Chave da conta de integralização (UUID). Presente quando informada. | ## Enumeradores de `type` | Valor | Descrição | |---|---| | `scheduled_amortization` | Amortização programada/agendada | | `extraordinary_amortization` | Amortização extraordinária | ## Enumeradores de `regime_type` | Valor | Descrição | |---|---| | `cash_availability` | Baseado na disponibilidade de caixa | | `issuance_serie_principal_percentage` | Percentual do principal da série de emissão | | `quota_percentage` | Percentual de cotas | | `financial_application_principal_percentage` | Percentual do principal da aplicação financeira | | `net_value` | Valor líquido fixo | | `gross_value` | Valor bruto fixo | | `financial_application_yield_percentage` | Percentual de rendimento da aplicação financeira | ## Enumeradores de `status` | Status | Descrição | |---|---| | `created` | Solicitação criada | | `waiting_quotation_date` | Aguardando data de cotização | | `pending_inputs` | Aguardando dados de entrada | | `processing_calculation` | Cálculo em processamento | | `processing_investor_amortizations` | Processando amortizações dos investidores | | `pending_manual_approval` | Aguardando aprovação manual | | `processing_approval` | Aprovação em processamento | | `processing_issuance_serie_impacts` | Processando impactos na série de emissão | | `reprocessed` | Reprocessada | | `reproved` | Reprovada | | `done` | Concluída | | `blocked` | Bloqueada | ## Enumeradores de status do `investor_amortization` | Status | Descrição | |---|---| | `created` | Amortização do investidor criada | | `pending_quote` | Aguardando cotação | | `processing_approval` | Aprovação em processamento | | `pending_manual_approval` | Aguardando aprovação manual | | `done` | Concluída | | `reproved` | Reprovada | | `reprocessed` | Reprocessada | | `blocked` | Bloqueada | ## Enumeradores de `payment_method` | Valor | Descrição | |---|---| | `regular` | Pagamento padrão (TED/PIX) | | `b3` | Pagamento via B3 | ## Enumeradores de `payment_type` | Valor | Descrição | |---|---| | `amortization_payment.investor` | Pagamento de amortização ao investidor | | `amortization_payment.ir` | Recolhimento de IR da amortização | | `amortization_payment.iof` | Recolhimento de IOF da amortização | | `amortization_payment.collateral` | Pagamento de garantia da amortização | | `redemption.investor` | Pagamento de resgate ao investidor | | `redemption.ir` | Recolhimento de IR do resgate | | `redemption.iof` | Recolhimento de IOF do resgate | | `redemption.integralization_iof` | Recolhimento de IOF de integralização do resgate | | `redemption.tax_anticipation` | Antecipação de tributos do resgate | ## Enumeradores de status do `payment` | Status | Descrição | |---|---| | `created` | Pagamento criado | | `pending_payment` | Aguardando pagamento | | `pending_manual_approval` | Aguardando aprovação manual | | `pending_confirmation` | Aguardando confirmação | | `pending_accounting_date` | Aguardando data contábil | | `paid` | Pago | | `canceled` | Cancelado | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------- | | 400 | `QIT000004` | O fundo não é da gestora | | 404 | `QTA000002` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de Aplicação Financeira URL: /documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras Lista as aplicações financeiras de um cotista ou de uma classe de fundo, com paginação. ## Por cotista Retorna as aplicações financeiras de um cotista. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------------------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota/investor/INVESTOR_KEY/financial_applications MÉTODO GET STATUS 200 Para a gestora, a consulta retorna apenas aplicações em fundos dela, e só de investidores aos quais ela está vinculada. ### Query Params | Parâmetro | Descrição | | ---------------------------- | --------------------------------------------------------------------------------------------- | | `page` | Página, a partir de 0 (default 0) | | `limit` | Itens por página (default 20, máximo 500) | | `status` | Lista de **[Financial Application Status](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave#financial_application_status)** | | `types` | Lista de tipos: `primary_market`, `secondary_market` | | `issuance_serie_key` | Filtra por série de emissão | | `quotation_date` | Data de cotização (`yyyy-mm-dd`) | | `fund_class_document_number` | CNPJ da classe de fundo | | `application_from_datetime` | Aplicações com data/hora maior ou igual ao valor, no formato `yyyy-mm-ddTHH:MM:SSZ` (UTC) | | `application_to_datetime` | Aplicações com data/hora menor ou igual ao valor, no formato `yyyy-mm-ddTHH:MM:SSZ` (UTC) | ## Por classe de fundo Retorna as aplicações financeiras de uma classe de fundo da gestora, da mais recente para a mais antiga. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota/fund_class/FUND_CLASS_KEY/financial_applications MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | | --------------------------- | ---------------------------------------------------------------------------------------------- | | `page` | Página, a partir de 0 (default 0) | | `limit` | Itens por página (default 20, máximo 100) | | `status` | Lista de **[Financial Application Status](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave#financial_application_status)** | | `investor_name` | Parte do nome do investidor (sem diferenciar maiúsculas) | | `investor_document_number` | CPF/CNPJ do investidor | | `quotation_date` | Data de cotização (`yyyy-mm-dd`) | | `application_from_datetime` | Aplicações com data/hora maior ou igual ao valor, no formato `yyyy-mm-ddTHH:MM:SSZ` (UTC) | | `application_to_datetime` | Aplicações com data/hora menor ou igual ao valor, no formato `yyyy-mm-ddTHH:MM:SSZ` (UTC) | `limit` acima do máximo devolve 400. ## Response As duas consultas devolvem a mesma estrutura. Cada item de `data` é o objeto **Financial Application** descrito em [Consultar Aplicação Financeira por chave](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave#financial_application). ```json { "data": [ { "financial_application_key": "UUID", "share_capital": 1000.0, "status": "quoted", "financial_application_type": "primary_market", "quotation_date": "2025-01-10" } ], "limit": 20, "page": 0, "is_last_page": true } ``` | Campo | Tipo | Descrição | | -------------- | ------- | --------------------------------------------- | | `data` | array | Lista de aplicações financeiras | | `limit` | int | Itens por página | | `page` | int | Página retornada | | `is_last_page` | boolean | `true` quando não há mais páginas | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------------------------------------------------------------- | | 400 | `QIT000001` | Data ou data/hora em formato inválido | | 400 | `QIT000004` | A gestora não é a gestora do fundo ou não está vinculada ao investidor | | 404 | `QTA000002` | Classe de fundo não encontrada (consulta por classe) | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de Fechamento das Aplicações Financeiras URL: /documentation/iaas/passivo/aplicacao_financeira/busca_paginada_fechamento_das_aplicacoes_financeiras Lista os fechamentos diários (posição contábil) das aplicações financeiras, por classe de fundo ou por aplicação. ## Por classe de fundo :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota/fund_class/FUND_CLASS_KEY/financial_application_closings MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | | -------------------------- | ------------------------------------------------------------------------- | | `accounting_date` | Data contábil específica de fechamento (`yyyy-mm-dd`) | | `from_date` | Data de início do período (`yyyy-mm-dd`) | | `to_date` | Data de fim do período (`yyyy-mm-dd`) | | `investor_document_number` | CPF/CNPJ do investidor | | `limit` | Itens por página (default 75, máximo 75) | | `page` | Página, a partir de 0 (default 0) | :::caution Atenção Envie `accounting_date` **ou** o par `from_date` e `to_date` — nunca os dois. Sem nenhum deles, a API devolve `QTA000026`; com os dois, `QIT000001`. Parâmetros fora desta lista também são recusados com `QIT000001`. ::: Os resultados vêm ordenados da data contábil mais recente para a mais antiga. ## Por investidor e aplicação financeira :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY/financial_application_closings MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `last_financial_application_closing` | Booleano. Quando `true`, retorna apenas o último fechamento da aplicação (default `false`) | | `limit` | Itens por página (default 50, máximo 500) | | `page` | Página, a partir de 0 (default 0) | ## Response Caso 01: Consulta bem-sucedida ```json { "data": [ { "financial_application": { "financial_application_key": "UUID", "share_capital": 1000.0, "status": "quoted", "financial_application_type": "primary_market", "payment_method": "regular", "quotation_date": "2025-01-10", "investor": { "investor_key": "UUID", "name": "INVESTIDOR EXEMPLO", "person_type": "natural_person" }, "issuance_serie": { "issuance_serie_key": "UUID" } }, "total_value": 1012.35, "number_of_quotas": 998.12345678, "principal_value": 1000.0, "acquisition_cost": 1000.0, "yield_value": 12.35, "ir_value": 2.78, "iof_value": 0.0, "taxable_yield_value": 12.35, "accounting_date": "2025-01-31" } ], "limit": 75, "page": 0, "is_last_page": true } ``` | Campo | Tipo | Descrição | | -------------- | ------- | --------------------------------------------------------------------------------------- | | `data` | array | Lista de objetos **[Financial Application Closing](#financial-application-closing)** | | `limit` | int | Itens por página | | `page` | int | Página retornada | | `is_last_page` | boolean | `true` quando não há mais páginas | ### Financial Application Closing | Campo | Tipo | Descrição | | ----------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | `financial_application` | object | Aplicação financeira completa, no formato de [Consultar Aplicação Financeira por chave](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave#financial_application) | | `total_value` | float | Valor total da aplicação no fechamento | | `number_of_quotas` | float | Número de cotas no fechamento | | `principal_value` | float | Valor principal no fechamento | | `acquisition_cost` | float | Custo de aquisição das cotas no fechamento | | `yield_value` | float | Rendimento bruto | | `ir_value` | float | IR | | `iof_value` | float | IOF | | `taxable_yield_value` | float | Rendimento tributável | | `accounting_date` | string | Data contábil do fechamento | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------------------------------- | | 400 | `QTA000026` | Consulta por classe sem `accounting_date` nem o par `from_date`/`to_date` | | 400 | `QIT000001` | Parâmetro inválido ou desconhecido, `limit` acima de 75, ou `accounting_date` junto com `from_date`/`to_date` | | 400 | `QIT000004` | O fundo não é da gestora | | 404 | `QTA000020` | Investidor não encontrado (a API responde com o erro de distribuidor não encontrado) | | 404 | `QTA000023` | Aplicação financeira não encontrada para o investidor | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consultar Aplicação Financeira por chave URL: /documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave Retorna uma aplicação financeira de um investidor pela chave. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------------------------- | | Gestora | `manager-api` | Leitura | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY MÉTODO GET STATUS 200 A gestora só consulta investidores aos quais está vinculada; a consultoria, aplicações de fundos em que tem permissão. ## Responses Caso 01: Consulta bem-sucedida ```json { "financial_application_key": "UUID", "external_id": "SEU_ID_EXTERNO", "share_capital": 1000.0, "status": "quoted", "financial_application_type": "primary_market", "payment_method": "regular", "central_depositary": "unregistered", "quotation_date": "2025-01-10", "original_number_of_quotas": 998.12345678, "original_number_of_quotas_str": "998.12345678", "current_number_of_quotas": 998.12345678, "current_principal_value": 1000.0, "acquisition_cost": 1000.0, "status_events": [ { "event_datetime": "2025-01-09T14:30:00Z", "status": "pending_payment" }, { "event_datetime": "2025-01-10T21:00:00Z", "status": "quoted" } ], "redemptions": [], "amortizations": [], "investor": { "investor_key": "UUID", "name": "INVESTIDOR EXEMPLO", "person_type": "natural_person", "document_number": "969.698.790-03", "distributor": { "distributor_key": "UUID", "document_number": "11.222.333/0001-81", "name": "DISTRIBUIDORA EXEMPLO", "account_data": {} } }, "issuance_serie": { "issuance_serie_key": "UUID", "name": "SERIE 1", "serie": 1, "status": "active", "remuneration_type": "yield_curve", "original_quota_value": 1.0, "current_quota_value": 1.0018, "sub_class": { "name": "COTA SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "name": "FUNDO EXEMPLO", "fund_class_key": "UUID", "document_number": "11.222.333/0001-81" } } }, "water_mark_events": [] } ``` Campos opcionais (`external_id`, `original_number_of_quotas`, `current_number_of_quotas`, `current_principal_value`, `acquisition_cost`, `quotation_date`) só aparecem quando preenchidos. As listas `status_events`, `redemptions`, `amortizations` e `reserved_taxable_yields` são omitidas quando vazias. ### Financial Application {#financial_application} | Campo | Tipo | Descrição | | ------------------------------- | ------ | -------------------------------------------------------------------------------- | | `financial_application_key` | string | Chave única da aplicação financeira | | `external_id` | string | Identificador externo | | `share_capital` | float | Valor aplicado | | `status` | string | Enumerador de **[Financial Application Status](#financial_application_status)** | | `financial_application_type` | string | `primary_market` (aplicação) ou `secondary_market` (mercado secundário) | | `payment_method` | string | `regular` (Pix ou TED) ou `b3` | | `central_depositary` | string | `unregistered` ou `cetip` | | `quotation_date` | string | Data de cotização (`yyyy-mm-dd`) | | `original_number_of_quotas` | float | Quantidade de cotas na cotização (`_str`: o mesmo valor como string, sem arredondamento) | | `current_number_of_quotas` | float | Quantidade atual de cotas | | `current_principal_value` | float | Principal atual | | `acquisition_cost` | float | Custo de aquisição | | `status_events` | array | Histórico de status: `status` e `event_datetime` (UTC) | | `redemptions` | array | Resgates que consumiram a aplicação: `redemption_key`, `redemption_type`, `number_of_quotas`, `total_value`, `ir_value`, `iof_value`, `yield_value`, `taxable_yield_value`, `redemption_date` | | `amortizations` | array | Amortizações pagas: `amortization_key`, `payment_date`, `total_value`, `principal_reduction`, `acquisition_cost_reduction` e, quando houver, `yield_value`, `taxable_yield_value`, `ir_value`, `iof_value` | | `reserved_taxable_yields` | array | Rendimentos tributáveis reservados (come-cotas) | | `investor` | object | Investidor: `investor_key`, `name`, `person_type`, `document_number` e `distributor` | | `issuance_serie` | object | Série de emissão, com `sub_class` e `sub_class.fund_class` | | `water_mark_quota_value` | float | Valor de cota de referência da marca d'água (taxa de performance), quando houver | | `water_mark_reference_date` | string | Data de referência da marca d'água, quando houver | | `water_mark_events` | array | Eventos de marca d'água | ### Financial Application Status {#financial_application_status} | Enumerador | Descrição | | ----------------------------------- | ----------------------------------------------- | | `created` | Criada | | `pending_formalization` | Pendente de formalização (boletim de subscrição) | | `pending_payment` | Pendente de pagamento | | `processing_quotation` | Cotização em processamento | | `pending_quote` | Pendente de cotização | | `processing_issuance_serie_impacts` | Processando impactos na série | | `quoted` | Cotizada | | `settled` | Totalmente amortizada | | `redeemed` | Totalmente resgatada | | `canceled` | Cancelada | | `reprocessed` | Reprocessada | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------------------------------------------- | | 400 | `QIT000004` | A gestora não está vinculada ao investidor | | 403 | `QTA000315` | A consultoria não tem permissão no fundo da aplicação | | 404 | `QTA000021` | Investidor não encontrado | | 404 | `QTA000260` | Aplicação financeira não encontrada para o investidor | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Criar Aplicação Financeira URL: /documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira Cria uma aplicação financeira de um investidor em uma série de emissão. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | --------------------------------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/investor/INVESTOR_KEY/financial_application MÉTODO POST STATUS 201 ```json title='Request Body' { "issuance_serie_key": "UUID", "share_capital": 0.00, "payment_method": "b3 / regular", "central_depositary": "unregistered / cetip", "quotation_date": "yyyy-mm-dd" } ``` :::info Campos obrigatórios - issuance_serie_key - share_capital ::: :::caution Atenção **payment_method** e **central_depositary** são opcionais. Se não forem enviados, a API usa os valores marcados como default na tabela abaixo (`regular` e `unregistered`). - Com **central_depositary** `cetip`, o **payment_method** pode ser `regular` ou `b3`. Com `unregistered`, apenas `regular` (`b3` devolve o erro `QTA000359`). ::: ### Body params | Campo | Tipo | Descrição | |-----------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | `issuance_serie_key` | string | Chave única de identificação da Série de emissão | | `share_capital` | float | Valor da aplicação financeira (maior ou igual a 0). Se a série tiver valor mínimo de aplicação, o valor precisa atingi-lo | | `payment_method` | string | Método de Pagamento. Valores esperados:
• regular: Pix ou TED **(default)**
• b3: Via B3 | | `central_depositary` | string | Tipo de depositárias. Valores esperados:
• unregistered: Sem registradora **(default)**
• cetip: Registrado na Cetip | | `quotation_date` | string | Data de cotização da aplicação, no formato yyyy-mm-dd (opcional). Precisa ser dia útil e não pode ser anterior à data contábil do fundo. Se omitida, é calculada pela configuração de prazos da série | ## Response A resposta traz o objeto da aplicação financeira criada, no mesmo formato da [consulta por chave](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave). Guarde o `financial_application_key`. ```json title='Response Body (resumido)' { "financial_application_key": "UUID", "share_capital": 1000.0, "status": "pending_payment", "financial_application_type": "primary_market", "payment_method": "regular", "central_depositary": "unregistered", "quotation_date": "2025-01-10" } ``` ## Erros | Status | Código | Quando acontece | | ------ | ----------- | --------------------------------------------------------------------------------------------------- | | 400 | `QIT000001` | Corpo inválido: campo obrigatório ausente, tipo errado ou campo não previsto | | 400 | `QIT000004` | A série não pertence a um fundo da gestora | | 400 | `QTA000359` | `payment_method` `b3` com `central_depositary` `unregistered` | | 400 | `QTA000272` | `share_capital` abaixo do valor mínimo de aplicação da série | | 400 | `QTA000176` | `quotation_date` não é dia útil | | 400 | `QTA000225` | `quotation_date` anterior à data contábil do fundo | | 400 | `QTA000264` | Valor acima do disponível na oferta ou no boletim de subscrição (fundo fechado) | | 400 | `QTA000267` | O boletim de subscrição do investidor ainda não está pronto para subscrição (fundo fechado) | | 400 | `QTA000269` | A aplicação deixaria a subclasse desenquadrada (índice de subordinação) | | 403 | `QTA000315` | A consultoria não tem permissão no fundo da série | | 404 | `QTA000004` | Valor inválido em `payment_method` ou `central_depositary` | | 404 | `QTA000015` | `issuance_serie_key` não encontrada | | 404 | `QTA000021` | Investidor não encontrado (na `manager-api`, hoje a resposta vem como `QTA000020`) | | 404 | `QTA000265` | O investidor não tem boletim de subscrição (fundo fechado) | | 404 | `QTA000266` | A série não tem oferta de cotas (fundo fechado) | | 422 | `QTA000425` | A série de emissão já foi liquidada | | 422 | `QTA000357` | Movimentação bloqueada: a série está com valor de cota zerado ou negativo | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Aprovação manual de bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/aprovar_bloqueio_pendente_aprovacao --- ## Introdução Este recurso tem como objetivo detalhar o fluxo de aprovação manual de um bloqueio. :::caution Atenção O Bloqueio de cotas somente irá para pendente aprovação manual caso o valor do bloqueio ultrapasse o valor total do patrimônio em até **3.8%** ::: :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Escrita | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Aprovação ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/pending_manual_approval/approve MÉTODO PUT STATUS 204 ## Reprovação ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/pending_manual_approval/reprove MÉTODO PUT STATUS 204 ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consultar bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas --- ## Introdução Este recurso tem como objetivo detalhar as informações de uma solicitação de **bloqueio de cotas** de um **investidor**. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY MÉTODO GET STATUS 200 ## Response ```json { "quota_lock_key": "UUID", "status": "pending_documents", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0, "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_key": "UUID", "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } }, "documents": [ { "document_key": "UUID", "document_type": "asset_document" } ] } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 } ], "documents": [ { "document_key": "UUID", "document_type": "collateral_contract" } ] }, "investor_positions_locks": [ { "investor_position_lock_key": "UUID", "investor_position_key": "UUID", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0 } ] } ``` ## Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------------|------------| | `quota_lock_key` | string | Identificador único do bloqueio de cotas | 36 | | `status` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | | `collateral` | JSON | Objeto de **[Garantia](#collateral)** | - | | `investor_positions_locks` | Array | Lista de objetos de **[Bloqueio de posição do investidor](#locked-investor-positions)** | - | ## Quota Lock Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_documents` | Pendente documentos | | `pending_approval` | Pendente aprovação | | `denied` | Negado | | `approved` | Aprovado | ## Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ## Collateral | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------------------------|------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | | `documents` | Array | Lista de objetos de **[Documento da garantia](#document)** | - | ## Issuance Serie {#issuance_serie} | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `issuance_serie_key` | string | Chave da série de emissão | 36 | | `number_of_quotas` | float | Número de cotas bloqueadas | - | | `financial_value` | float | Valor financeiro bloqueado | - | ## Recipient | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do beneficiário | até 255 | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ## Borrower | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do tomador | até 255 | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ## Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ## Natural Person {#natural_person} | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `birthdate` | string | Data de nascimento | 10 | | `mother_name` | string | Nome da mãe | até 255 | ## Legal Person {#legal_person} | Campo | Tipo | Descrição | Caracteres | |------------------|----------|----------------------------------------------------------|--------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | ## Representative | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|------------------------------------------------|--------------| | `name` | string | Nome do representante | até 255 | | `document_number` | string | CPF do representante | 14 | ## Asset | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `asset_key` | string | Identificador único do ativo | até 255 | | `asset_type` | string | Enumerador de tipo de ativo | até 255 | | `status` | string | Enumerador de status de ativo | até 255 | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | | `documents` | Array | Lista de objetos de **[Documento do ativo](#document)** | - | ## Asset Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_approval` | Pendente aprovação | | `done` | concluído | ## Document | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `document_key` | string | Identificador único do ativo | até 255 | | `document_type` | string | Enumerador de tipo de ativo | até 255 | ## Asset Type | Enumerador | Descrição | |--------------------------|-----------| | `ccb` | CCB | | `cce` | CCE | ## Credit Operation {#credit_operation} | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `contract_number` | string | N° do contrato | até 255 | | `principal_value` | string | Valor de principal da operação | - | | `interest_rate_type` | string | Enumerador de pós-fixada / pré-fixada | até 255 | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pos_fixed)** | - | ## Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ## Pre fixed {#pre_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ## Post fixed {#pos_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ## calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ## Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ## Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ## Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ## Locked Investor Positions | Campo | Tipo | Descrição | Caracteres | |---------------------------------|------- |-----------------------------------------------------------------------|------------| | `investor_position_lock_key` | string | Identificador único do bloqueio da posição do investor | 36 | | `investor_position_key` | string | Identificador único da posição do investidor | 36 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consultar bloqueio de cotas de um investidor URL: /documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas_de_um_investidor --- ## Introdução Este recurso tem como objetivo detalhar as informações de todas as solicitação de **bloqueio de cotas** de um **investidor**. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_locks MÉTODO GET STATUS 200 ## Response ```json { "data": [ { "quota_lock_key": "UUID", "status": "pending_documents", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0, "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_key": "UUID", "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } }, "documents": [ { "document_key": "UUID", "document_type": "asset_document" } ] } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 } ], "documents": [ { "document_key": "UUID", "document_type": "collateral_contract" } ] }, "investor_positions_locks": [ { "investor_position_lock_key": "UUID", "investor_position_key": "UUID", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0 } ] }, { "quota_lock_key":"04eeaabc-cb40-484a-b730-85ed5aed7bbf", "status":"approved", "type":"lawsuit", "original_locked_value":"50000.00", "current_locked_value":"50000.00", "lawsuit":{ "protocol":"20250037746822", "lock_date":"2024-01-15", "unlock_date":"2024-01-16", "process_number":"13289520258250000", "document_number":"236.682.501-38", "requested_amount":50000.0 } } ], "page": 0, "is_last_page": true } ``` ## Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------------|------------| | `quota_lock_key` | string | Identificador único do bloqueio de cotas | 36 | | `status` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | | `collateral` | JSON | Objeto de **[Garantia](#collateral)** | - | | `investor_positions_locks` | Array | Lista de objetos de **[Bloqueio de posição do investidor](#locked-investor-positions)** | - | ## Quota Lock Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_documents` | Pendente documentos | | `pending_approval` | Pendente aprovação | | `denied` | Negado | | `approved` | Aprovado | ## Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ## Collateral | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------------------------|------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | | `documents` | Array | Lista de objetos de **[Documento da garantia](#document)** | - | ## Issuance Serie {#issuance_serie} | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `issuance_serie_key` | string | Chave da série de emissão | 36 | | `number_of_quotas` | float | Número de cotas bloqueadas | - | | `financial_value` | float | Valor financeiro bloqueado | - | ## Recipient | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do beneficiário | até 255 | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ## Borrower | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do tomador | até 255 | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ## Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ## Natural Person {#natural_person} | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `birthdate` | string | Data de nascimento | 10 | | `mother_name` | string | Nome da mãe | até 255 | ## Legal Person {#legal_person} | Campo | Tipo | Descrição | Caracteres | |------------------|----------|----------------------------------------------------------|--------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | ## Representative | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|------------------------------------------------|--------------| | `name` | string | Nome do representante | até 255 | | `document_number` | string | CPF do representante | 14 | ## Asset | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `asset_key` | string | Identificador único do ativo | até 255 | | `asset_type` | string | Enumerador de tipo de ativo | até 255 | | `status` | string | Enumerador de status de ativo | até 255 | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | | `documents` | Array | Lista de objetos de **[Documento do ativo](#document)** | - | ## Asset Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_approval` | Pendente aprovação | | `done` | concluído | ## Document | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `document_key` | string | Identificador único do ativo | até 255 | | `document_type` | string | Enumerador de tipo de ativo | até 255 | ## Asset Type | Enumerador | Descrição | |--------------------------|-----------| | `ccb` | CCB | | `cce` | CCE | ## Credit Operation {#credit_operation} | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `contract_number` | string | N° do contrato | até 255 | | `principal_value` | string | Valor de principal da operação | - | | `interest_rate_type` | string | Enumerador de pós-fixada / pré-fixada | até 255 | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pos_fixed)** | - | ## Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ## Pre fixed {#pre_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ## Post fixed {#pos_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ## calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ## Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ## Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ## Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ## Locked Investor Positions | Campo | Tipo | Descrição | Caracteres | |---------------------------------|------- |-----------------------------------------------------------------------|------------| | `investor_position_lock_key` | string | Identificador único do bloqueio da posição do investor | 36 | | `investor_position_key` | string | Identificador único da posição do investidor | 36 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Enviar Documento da Garantia URL: /documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_da_garantia --- ## Introdução Este recurso tem como objetivo nos enviar o **documento** relacionado a formalização da **garantia** ao qual se está solicitando o **bloqueio de cotas** ## Input / Output: Como ***input*** deve ser enviado o **tipo do documento** e o **base 64** do documento. Segue abaixo exemplo. Como ***output*** será entregue uma ***collateral_document_key***. A ***collateral_document_key*** é utilizada para identificar o **documento da garantia** enviado. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/document MÉTODO POST STATUS 201 ## Request body ```json title='Request Body' { "document_type": "collateral_contract", "document_b64" : "B64" } ``` ## Collateral Document | Campo | Tipo | Descrição | Caracteres | Obrigatório | |------------------|--------|------------------------------------------------------------|------------|-------------| | `document_type` | string | Enumerador de tipo de documento da garantia | até 255 | Sim | | `document_b64` | string | Conteúdo do documento codificado em base64 | - | Sim | ## Document Type | Enumerador | Descrição | |------------------------|------------------------| | `collateral_contract` | Contrato de garantia | | `rental_contract` | Contrato de aluguel | ## Response ```json title='Response Body' { "collateral_document_key": "UUID" } ``` ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Enviar Documento do Ativo URL: /documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_do_ativo --- ## Introdução Este recurso tem como objetivo nos enviar o **documento** do **ativo** que é objeto da **garantia** ao qual se está solicitando o **bloqueio de cotas** ## Input / Output: Como ***input*** deve ser enviado o **tipo do documento** e o **base 64** do documento. Segue abaixo exemplo. Como ***output*** será entregue uma ***asset_document_key***. A ***asset_document_key*** é utilizada para identificar o **documento do ativo** enviado. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/asset/ASSET_KEY/document MÉTODO POST STATUS 201 ## Request body ```json title='Request Body' { "document_type": "asset_document", "document_b64" : "B64" } ``` ## Response ```json title='Response Body' { "asset_document_key": "UUID" } ``` ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Execução de garantia URL: /documentation/iaas/passivo/bloqueio_de_cotas/execucao_de_garantia --- ## Introdução Este recurso tem como objetivo **executar uma garantia** constituída sobre as cotas de um **investidor**, convertendo o bloqueio em pagamento ao **credor**. Diferente dos demais eventos de bloqueio, a execução de garantia gera um **pedido de resgate** na classe do fundo e o valor apurado é pago **nominalmente ao credor** cadastrado na garantia — não ao investidor. A posição do investidor é reduzida na proporção das cotas resgatadas. ## Pré-requisitos Antes de solicitar a execução, confirme que: | Requisito | Detalhe | |-----------|---------| | Bloqueio aprovado | O bloqueio de cotas deve estar no status `approved`. | | Bloqueio do tipo garantia | Apenas bloqueios com o objeto `collateral` são executáveis. Bloqueios de penhora judicial não são. | | Credor identificado | `collateral.recipient` deve conter `name` e `document_number`. | | Conta bancária do credor | `collateral.recipient.bank_account` deve conter `account_number`, `account_branch`, `account_digit` e `financial_institution_ispb`. | O cadastro do credor e da conta bancária é feito no momento da [solicitação de bloqueio de cotas](/documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas). Uma execução solicitada sobre uma garantia com cadastro incompleto **não é registrada**. :::caution Atenção A conta bancária informada em `collateral.recipient.bank_account` é a **conta do credor** e é o destino do pagamento da execução. Não confundir com `collateral.bank_account_key`, que identifica uma conta **do investidor** e não participa da execução. ::: :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Escrita | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/investor_position_lock/INVESTOR_POSITION_LOCK_KEY/event MÉTODO POST STATUS 201 Execução de garantia ```json { "type": "collateral_execution", "net_value": 1000.00 } ``` ## Collateral Execution Event | Campo | Tipo | Descrição | Caracteres | Obrigatório | |--------------|--------|------------------------------------------------------------------------|------------|-------------| | `type` | string | Enumerador do tipo de evento. Para execução de garantia: `collateral_execution` | até 255 | Sim | | `net_value` | float | Valor líquido a ser executado e pago ao credor | - | Sim | O valor informado em `net_value` não pode exceder o valor financeiro bloqueado no momento da solicitação. ## Response Execução registrada ```json { "investor_position_lock_event_key": "UUID" } ``` | Campo | Tipo | Descrição | Caracteres | |------------------------------------|--------|-------------------------------------------------------|------------| | `investor_position_lock_event_key` | string | Identificador do evento de execução criado | 36 | ## O que acontece após a solicitação 1. O evento de execução é registrado com o status `pending_processing`. Os valores bloqueados **permanecem integralmente bloqueados** neste momento. 2. Um pedido de resgate do tipo `net_value_redemption` é aberto automaticamente na classe do fundo, no valor informado. 3. O pedido de resgate é cotizado no ciclo normal da classe. O pagamento é emitido para a conta do credor, **líquido de IR e IOF**. 4. Com a cotização concluída, a quantidade de cotas efetivamente resgatada é abatida do bloqueio e o evento passa para `done`. Caso o pedido de resgate seja cancelado antes da cotização, o evento de execução passa para `canceled` e os valores bloqueados são **preservados integralmente** — não há baixa parcial. ## Event Status | Enumerador | Descrição | |-----------------------|-------------------------------------------------------------------------------| | `pending_processing` | Execução registrada, aguardando a cotização do pedido de resgate | | `done` | Execução concluída, cotas abatidas do bloqueio | | `canceled` | Execução cancelada, valores bloqueados preservados | ## Acompanhamento O status da execução é consultado pelo endpoint de [consulta de bloqueio de cotas](/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas), no objeto `investor_position_locks[].events[]`. Evento na consulta de bloqueio ```json { "investor_position_locks": [ { "investor_position_lock_key": "UUID", "current_locked_quotas": 100.00000000000000, "events": [ { "quota_lock_event_key": "UUID", "type": "collateral_execution", "status": "pending_processing" } ] } ] } ``` :::info Na resposta da consulta, o identificador do evento é retornado no campo `quota_lock_event_key`. Ele corresponde ao `investor_position_lock_event_key` devolvido na criação. ::: Concluída a execução, o mesmo evento passa a apresentar `status: "done"` e o campo `new_locked_quotas` com a quantidade de cotas remanescente no bloqueio. Não há webhook dedicado a eventos de execução de garantia. Os webhooks disponíveis para bloqueio de cotas estão descritos em [Webhooks de bloqueio de cota](/documentation/iaas/passivo/bloqueio_de_cotas/webhooks_de_bloqueio_de_cota). ## Erros | Status | Código | Quando acontece | |--------|-------------|---------------------------------------------------------------------------------| | 400 | `QLK000044` | O `net_value` informado é nulo, zero ou negativo | | 400 | `QLK000042` | O `net_value` informado excede o valor bloqueado | | 400 | `QLK000036` | O agente selecionado não é o solicitante do bloqueio | | 404 | `QLK000022` | Bloqueio de cotas não encontrado | | 404 | `QLK000037` | Posição bloqueada não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Reduzir bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/reduzir_bloqueio_de_cotas --- ## Introdução Este recurso tem como objetivo reduzir o valor de **bloqueio de cotas** de um **investidor**. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Escrita | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/investor_position_lock/INVESTOR_POSITION_LOCK_KEY/event MÉTODO POST STATUS 201 Redução de valor bloqueado ```json { "type": "decrease_locked_value", "new_locked_value": 0.00 } ``` Redução de quantidade de cotas bloqueadas ```json { "type": "decrease_locked_quotas", "new_locked_quotas": 0.00 } ``` Execução de garantia ```json { "type": "collateral_execution", "net_value": 0.00 } ``` ## Locked Investor Position Event | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------------|------------|-------------| | `type` | string | Enumerador de tipo de evento | até 255 | Sim | | `new_locked_value` | float | Novo valor financeiro bloqueado | - | Não | | `new_locked_quotas` | float | Nova quantidade de cotas bloqueadas | - | Não | | `net_value` | float | Valor líquido apurado na execução de garantia | - | Não | Obrigatoriamente um — e apenas um — entre `new_locked_value`, `new_locked_quotas` e `net_value` deve ser enviado. ## Event Type | Enumerador | Descrição | |---------------------------|--------------------------------------------------| | `decrease_locked_quotas` | Diminuir quantidade de cotas bloqueadas | | `decrease_locked_value` | Diminuir valor financeiro bloqueado | | `collateral_execution` | Execução de garantia | O evento `collateral_execution` tem fluxo, pré-requisitos e acompanhamento próprios, descritos em [Execução de garantia](/documentation/iaas/passivo/bloqueio_de_cotas/execucao_de_garantia). ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Solicitar bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas --- ## Introdução Este recurso tem como objetivo criar uma solicitação de **bloqueio de cotas** de um **investidor**. ## Input / Output: Deve ser enviado o **tipo de bloqueio** e a informação específica do tipo de bloqueio. Como ***output*** será entregue a ***quota_lock_key*** que representa o **bloqueio de cota**. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Liberada pelo time de integração | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock MÉTODO POST STATUS 201 Bloqueio de cotas por garantia - CCE - pessoa física ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00 } ], "bank_account_key": "UUID" } } ``` Bloqueio de cotas por garantia - CCE - pessoa jurídica ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Recipient Representative Name", "document_number": "000.000.000-00" } ] } }, "borrower": { "name": "Sample Borrower Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Borrower Representative Name", "document_number": "000.000.000-00" } ] } }, "assets": [ { "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00 } ], "bank_account_key": "UUID" } } ``` Bloqueio de cotas por garantia - contrato de aluguel - pessoa física ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_type": "rental_contract", "rental_contract": { "monthly_value": 0.0, "property_address": { "street": "Sample Street", "number": "123", "neighborhood": "Sample Neighborhood", "city": "Sample City", "uf": "SP", "complement": "Sample Complement", "postal_code": "00000-000", "country": "BRA" }, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "readjustment_index": 0.0 } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00 } ], "bank_account_key": "UUID" } } ``` Bloqueio de cotas por garantia - contrato de aluguel - pessoa jurídica ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Recipient Representative Name", "document_number": "000.000.000-00" } ] } }, "borrower": { "name": "Sample Borrower Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Borrower Representative Name", "document_number": "000.000.000-00" } ] } }, "assets": [ { "asset_type": "rental_contract", "rental_contract": { "monthly_value": 0.0, "property_address": { "street": "Sample Street", "number": "123", "neighborhood": "Sample Neighborhood", "city": "Sample City", "uf": "SP", "complement": "Sample Complement", "postal_code": "00000-000", "country": "BRA" }, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "readjustment_index": 0.0 } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "financial_application_keys": [ "UUID", "UUID" ] } ], "bank_account_key": "UUID" } } ``` ## Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------|------------| | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `collateral` | JSON | Objeto de **[Garantia](#collateral)** | - | ## Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ## Collateral | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |------------------------------------------------------------------|------------|-------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | Sim | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | Sim | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | Sim | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | Sim | | `bank_account_key` | string | UUID da conta bancária associada à garantia | - | Não | ## Recipient | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|-------------| | `name` | string | Nome do beneficiário | até 255 | Sim | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | Sim | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | Sim | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | Não | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | Não | ## Borrower | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|------------ | | `name` | string | Nome do tomador | até 255 | Sim | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | Sim | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | Sim | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | Não | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | Não | ## Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ## Natural Person {#natural_person} | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|-------------| | `birthdate` | string | Data de nascimento | 10 | Sim | | `mother_name` | string | Nome da mãe | até 255 | Sim | ## Legal Person {#legal_person} | Campo | Tipo | Descrição | Caracteres | Obrigatório | |------------------|----------|----------------------------------------------------------|--------------|-------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | Sim | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | Sim | ## Representative | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|------------------------------------------------|--------------|-------------| | `name` | string | Nome do representante | até 255 | Sim | | `document_number` | string | CPF do representante | 14 | Sim | ## Asset | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|--------------------------------------------------------|--------------|-------------| | `asset_type` | string | Enumerador de tipo de ativo | até 255 | Sim | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | Não | | `rental_contract` | JSON | Objeto de **[Contrato de Aluguel](#rental_contract)** | - | Não | ## Asset Type | Enumerador | Descrição | |--------------------------|-----------------------| | `ccb` | CCB | | `cce` | CCE | | `rental_contract` | Contrato de aluguel | ## Credit Operation {#credit_operation} | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|-------------------------------------------------------|--------------|-------------| | `contract_number` | string | N° do contrato | até 255 | Sim | | `principal_value` | string | Valor de principal da operação | - | Sim | | `interest_rate_type` | string | Enumerador de Pós-fixada / pré-fixada | até 255 | Sim | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | Não | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pos_fixed)** | - | Não | ## Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ## Pre fixed {#pre_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ## Post fixed {#pos_fixed} | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ## calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ## Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ## Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ## Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ## Rental Contract {#rental_contract} | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------------|----------|-------------------------------------------------------|--------------|-------------| | `monthly_value` | float | Valor mensal do aluguel | - | Sim | | `property_address` | JSON | Objeto de **[Endereço](#address)** do imóvel | - | Sim | | `start_date` | string | Data de início do contrato (YYYY-MM-DD) | 10 | Sim | | `end_date` | string | Data de término do contrato (YYYY-MM-DD) | 10 | Sim | | `readjustment_index` | float | Índice de reajuste do contrato | - | Não | ## Address | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------|----------|--------------------------------------------------|--------------|-------------| | `street` | string | Logradouro | até 255 | Não | | `number` | string | Número | - | Não | | `neighborhood` | string | Bairro | até 255 | Não | | `city` | string | Cidade | até 255 | Não | | `uf` | string | Unidade federativa (sigla de 2 letras) | 2 | Não | | `complement` | string | Complemento | até 255 | Não | | `postal_code` | string | CEP no formato `00000-000` | 9 | Não | | `country` | string | Código do país (3 letras) | 3 | Não | ## Issuance Serie {#issuance_serie} | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|-------------------------------------------------------|--------------|-------------| | `issuance_serie_key` | string | Chave da série de emissão | 36 | Sim | | `number_of_quotas` | float | Número de cotas a serem bloqueadas | - | Não | | `financial_value` | float | Valor financeiro a ser bloqueado | - | Não | ## Responses ```json title='Response Body' { "quota_lock_key": "UUID" } ``` ## Erros Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Webhook de bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/webhooks_de_bloqueio_de_cota --- ## Introdução Abaixo estão os detalhes sobre os webhooks enviados durante o processo de **bloqueio de cotas**. Bloqueio aprovado ```json { "webhook_type": "quota_lock.quota_lock_status_change", "webhook_datetime": "2024-12-05T00:00:00Z", "data": { "status": "approved", "quota_lock_key": "UUID" } } ``` Bloqueio reprovado ```json { "webhook_type": "quota_lock.quota_lock_status_change", "webhook_datetime": "2024-12-05T00:00:00Z", "data": { "status": "denied", "quota_lock_key": "UUID" } } ``` --- # Consulta paginada de investidores por classe de fundo URL: /documentation/iaas/passivo/consultas/consulta_investidores_classe_fundo Retorna **investidores que possuem aplicação financeira** vinculada à classe de fundo informada (via séries de emissão e subclasses), de forma paginada. Permite filtrar por documento, nome e data de fechamento. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/investors MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `document_number` | string | opcional | Filtra pelo documento do investidor com pontuação. | | `name` | string | opcional | Parte do nome do investidor (sem diferenciar maiúsculas). | | `reference_date` | string (data) | opcional | Retorna só investidores com fechamento de aplicação financeira nessa data contábil (`YYYY-MM-DD`). | ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/investors?page=0&limit=25&reference_date=2024-04-01 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "11.222.333/0001-81", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "11.222.333/0001-81" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "969.698.790-03", "external_id": "ext-inv-001", "external_distribution_key": null }, { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "11.222.333/0001-81", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "11.222.333/0001-81" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Investimentos PJ Ltda", "person_type": "legal_person", "document_number": "22.333.444/0001-81", "external_id": null, "external_distribution_key": "dist-key-7721" } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de investidores. | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página. | | `is_last_page` | boolean | Indica fim da paginação. | #### Campos de cada investidor em `data` | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Identificador único do investidor (UUID). | | `name` | string | Nome. | | `person_type` | string | Tipo de pessoa (enumerador, ex.: `natural_person`, `legal_person`). | | `document_number` | string | Documento, quando houver. | | `distributor` | object | Dados da distribuidora (`distributor_key`, `document_number`, `name`, `account_data`). | | `external_id` | string | Opcional — identificador externo. | | `external_distribution_key` | string | Opcional — chave de distribuição externa. | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------- | | 400 | `QIT000004` | O fundo não é da gestora | | 404 | `QTA000002` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de posições de cotistas por classe de fundo URL: /documentation/iaas/passivo/consultas/consulta_posicoes_cotistas_classe_fundo Endpoint de consulta paginada que retorna as **posições por investidor e série de emissão** em uma classe de fundo: cotistas com saldo de cotas na aplicação financeira, com valor de cota obtido do fechamento mais recente da série. Utilize `document_number` para filtrar um cotista específico. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/investor_positions MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Quantidade de registros por página. Padrão: `20`. Máximo: `100`. | | `document_number` | string | opcional | Filtra pelo documento do investidor (com pontuação). | ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/investor_positions?page=0&limit=20&document_number=969.698.790-03 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "investor": { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "11.222.333/0001-81", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "11.222.333/0001-81" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "969.698.790-03", "external_id": "ext-inv-001" }, "issuance_serie": { "issuance_serie_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "original_quota_value": 1.0, "current_number_of_quotas": 500000.0, "current_net_worth": 525000.75, "current_principal_value": 500000.0, "performance_fee_current_value": 0.0, "remuneration_type": "yield_curve", "interest_rate_type": "post_fixed", "name": "Série Única", "serie": 1, "sub_class": { "name": "Cota Sênior", "sub_class_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "subordination_level": 1, "fund_class": { "name": "Fundo Exemplo FIDC", "short_name": "FEX", "document_number": "11.222.333/0001-81", "fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "accounting_date": "2024-06-01", "sub_type": "regular", "tax_classification": "long_term", "condominum_type": "open_ended", "prevent_payment": false, "manager": { "manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345", "document_number": "11.222.333/0001-81", "manager_name": "Gestora Exemplo S.A." } } }, "status": "active", "internal_code": "INT-FEX-01", "current_quota_value": 1.0500015, "post_fixed": { "calendar_base": "calendar_252", "indexer": "cdi", "rate": 1.0, "lag": { "reference": "daily", "amount": 1 } }, "isin_code": "BRSTREXTFID6", "water_mark_events": [] }, "number_of_quotas": 10000.0, "quota_value": 1.05234567 } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de posições. Cada item agrega **investidor**, **série de emissão**, **quantidade de cotas** e **valor de cota** (`quota_value` quando existir fechamento). | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página solicitado. | | `is_last_page` | boolean | Indica se não há mais registros após esta página. | #### Objeto em `data` | Campo | Tipo | Descrição | |---|---|---| | `investor` | object | Dados do cotista e da distribuidora. | | `issuance_serie` | object | Série de emissão da posição, incluindo `sub_class` e `fund_class` aninhados. | | `number_of_quotas` | number | Soma das cotas da aplicação financeira para aquele investidor e série. | | `quota_value` | number | Valor de cota do fechamento mais recente da série; omitido se não houver fechamento disponível. | Campos opcionais de `issuance_serie` (como `pre_fixed`, `post_fixed`, `isin_code`, `external_id`) só aparecem quando preenchidos no cadastro da série. Só entram posições com saldo de cotas maior que zero, em fundos da gestora da integração. Um fundo de outra gestora devolve lista vazia. Para mais contexto sobre séries, consulte [Consulta paginada de séries de emissão](/documentation/iaas/cotas_de_fundo/consulta_paginada_series_de_emissao). ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------- | | 404 | `QTA000002` | Classe de fundo não encontrada | | 404 | `QTA00053` | Gestora da integração não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada dos fechamentos de uma série de emissão URL: /documentation/iaas/passivo/consultas/consultar_fechamentos_serie_de_emissao Retorna os **fechamentos diários** de uma série de emissão (cota e patrimônio líquido de cada etapa do fechamento), de forma paginada e ordenada da data contábil mais recente para a mais antiga. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/sub_class/{sub_class_key}/issuance_serie/{issuance_serie_key}/issuance_serie_closings MÉTODO GET STATUS 200 ### Path params | Parâmetro | Tipo | Descrição | |---|---|---| | `fund_class_key` | string | Chave única da classe de fundo (UUID). | | `sub_class_key` | string | Chave única da subclasse da série (UUID). | | `issuance_serie_key` | string | Chave única da série de emissão (UUID). | As chaves podem ser obtidas na **[Consulta paginada de todas as séries](/documentation/iaas/passivo/consultas/consultar_todas_series_de_emissao)**. ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `accounting_date` | string (data) | condicional | Data contábil de um fechamento específico (`YYYY-MM-DD`). | | `from_date` | string (data) | condicional | Data contábil inicial do período (`YYYY-MM-DD`). Deve ser enviada junto com `to_date`. | | `to_date` | string (data) | condicional | Data contábil final do período (`YYYY-MM-DD`). Deve ser enviada junto com `from_date`. | | `status` | string | opcional | Lista de status do fechamento separados por vírgula. `pending_distribution`: retorna o valor da cota das séries indexadas nos dias em que o fundo ainda não fechou. `closed`: retorna os fechamentos concluídos. Sem o parâmetro, retornam apenas os fechamentos com cota bruta já calculada. | | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Registros por página. Padrão: `50`. Máximo: `500`. | :::caution Atenção É obrigatório enviar `accounting_date` **ou** a combinação de `from_date` e `to_date`. Sem nenhum deles, a API devolve `QTA000026`. ::: ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/sub_class/{sub_class_key}/issuance_serie/{issuance_serie_key}/issuance_serie_closings?from_date=2026-09-29&to_date=2026-09-30&page=0&limit=50 ``` ## Response ```json title="Response Body" { "data": [ { "gross_quota_value": 1250.0, "gross_net_worth": 1250000.0, "accounting_date": "2026-09-30", "status": "closed", "before_amortization_quota_value": 1248.5, "before_amortization_net_worth": 1248500.0, "quota_value": 1248.5, "total_net_worth": 1248500.0, "closed_net_worth": 1248500.0, "closed_quota_value": 1248.5, "performance_fee_current_value": 1500.0 }, { "gross_quota_value": 1249.1, "gross_net_worth": 1249100.0, "accounting_date": "2026-09-29", "status": "closed", "before_amortization_quota_value": 1247.7, "before_amortization_net_worth": 1247700.0, "quota_value": 1247.7, "total_net_worth": 1247700.0, "closed_net_worth": 1247700.0, "closed_quota_value": 1247.7, "performance_fee_current_value": 1400.0 } ], "limit": 50, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de fechamentos da série, da data contábil mais recente para a mais antiga. | | `limit` | integer | Tamanho da página. | | `page` | integer | Página atual. | | `is_last_page` | boolean | Indica fim da paginação. | #### Campos de cada fechamento em `data` | Campo | Tipo | Descrição | |---|---|---| | `accounting_date` | string | Data contábil do fechamento (`YYYY-MM-DD`). | | `gross_quota_value` | float | Cota bruta, antes da taxa de performance. | | `gross_net_worth` | float | Patrimônio líquido bruto, antes da taxa de performance. | | `status` | string | Status do fechamento (ex.: `pending_distribution`, `closed`). | | `before_amortization_quota_value` | float | Cota após a taxa de performance e antes das amortizações. | | `before_amortization_net_worth` | float | Patrimônio líquido após a taxa de performance e antes das amortizações. | | `quota_value` | float | Cota final do dia, após as amortizações. | | `total_net_worth` | float | Patrimônio líquido final do dia, após as amortizações. | | `closed_quota_value` | float | Cota travada do fechamento. | | `closed_net_worth` | float | Patrimônio líquido travado do fechamento. | | `performance_fee_current_value` | float | Valor provisionado de taxa de performance. | Os campos além de `accounting_date`, `gross_quota_value` e `gross_net_worth` só aparecem quando já calculados para o dia. ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ----------------------------------------------------------------- | | 400 | `QTA000026` | Sem `accounting_date` e sem o par `from_date`/`to_date` | | 400 | `QIT000004` | O fundo não é da gestora | | 404 | `QTA000002` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada do Mapa de Evolução de Cotas URL: /documentation/iaas/passivo/consultas/consultar_mapa_de_evolucao_de_cotas Retorna, por dia, a evolução da cota de uma série de emissão (patrimônio, valor de cota, movimentações e rentabilidade), a partir das carteiras confirmadas do fundo. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | -------------------------------------- | | Gestora | `manager-api` | Leitura | | Consultoria | `consultant-api` | Ler Carteiras | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /composition/fund_class/FUND_CLASS_KEY/issuance_serie/ISSUANCE_SERIE_KEY/quota_evolution_map MÉTODO GET STATUS 200 ## Params | Parâmetro | Tipo | Obrigatório | Descrição | | -------------------- | ------ | ----------- | ------------------------- | | `fund_class_key` | `UUID` | Sim | Chave do fundo | | `issuance_serie_key` | `UUID` | Sim | Chave da série de emissão | ## Query Params | Parâmetro | Tipo | Obrigatório | Descrição | | ---------------- | ------------ | ----------- | ------------------------------------------------ | | `reference_date` | `YYYY-MM-DD` | Condicional | Data única de referência para consulta | | `start_date` | `YYYY-MM-DD` | Condicional | Data inicial do intervalo | | `end_date` | `YYYY-MM-DD` | Condicional | Data final do intervalo | | `limit` | `int` | Não | Quantidade de registros por página (default: 50, máximo: 100) | | `page` | `int` | Não | Página atual (default: 0) | :::caution Atenção Envie `reference_date` (um dia) **ou** o par `start_date` e `end_date` (um intervalo), nunca os dois. Os resultados vêm da data mais recente para a mais antiga. ::: Caso 01: Retorno com uma data ```json { "data": [ { "gross_net_worth": 10867777.38, "net_net_worth": 10867777.38, "gross_quota_value": 1.855893979904, "net_quota_value": 1.855893979904, "number_of_quotas": 5855818.003441199, "composition_date": "2025-05-04", "applied_value": 0.0, "applied_quotas": 0.0, "redeemed_value": 0.0, "redeemed_quotas": 0.0, "amortized_value": 0.0, "tax_anticipated_value": 0.0, "tax_anticipated_quotas": 0.0, "daily_rentability": 0.0006, "monthly_rentability": 0.0072, "yearly_rentability": 0.0898 } ], "is_last_page": true, "page": 0, "limit": 10 } ``` ## Quota Evolution Map | Campo | Tipo | Descrição | | ------------------------ | ------ | --------------------------------------------------------------- | | `gross_net_worth` | number | Patrimônio bruto no dia da composição | | `net_net_worth` | number | Patrimônio líquido no dia da composição | | `gross_quota_value` | number | Valor bruto da cota | | `net_quota_value` | number | Valor líquido da cota | | `number_of_quotas` | number | Quantidade total de cotas no dia | | `composition_date` | string | Data da composição (formato: `YYYY-MM-DD`) | | `applied_value` | number | Valor aplicado no dia | | `applied_quotas` | number | Quantidade de cotas aplicadas no dia | | `redeemed_value` | number | Valor resgatado no dia | | `redeemed_quotas` | number | Quantidade de cotas resgatadas no dia | | `amortized_value` | number | Valor amortizado no dia | | `tax_anticipated_value` | number | Valor de imposto antecipado no dia | | `tax_anticipated_quotas` | number | Quantidade de cotas com imposto antecipado no dia | | `daily_rentability` | number | Rentabilidade diária (formato decimal, ex: `0.0007` para 0.07%) | | `monthly_rentability` | number | Rentabilidade mensal (formato decimal, ex: `0.0060` para 0.60%) | | `yearly_rentability` | number | Rentabilidade anual (formato decimal, ex: `0.096` para 9.6%) | Os campos de rentabilidade só aparecem quando calculados para o dia. ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------------------------- | | 400 | `CMP000018` | Nenhum filtro de data enviado | | 400 | `CMP000019` | `reference_date` junto com `start_date`/`end_date`, ou só uma das datas do par | | 400 | `CMP000017` | `start_date` posterior a `end_date` | | 400 | `CMP000021` | A série não pertence ao fundo informado | | 400 | `QIT000004` | O fundo não é da gestora | | 403 | `CMP000032` | Consultoria: o fundo não é da gestora que concedeu o acesso | | 404 | `CMP000001` | Classe de fundo não encontrada | | 404 | `CMP000020` | Série de emissão não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de Séries de Emissão URL: /documentation/iaas/passivo/consultas/consultar_todas_series_de_emissao Lista as séries de emissão dos fundos da gestora, com paginação. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/issuance_series MÉTODO GET STATUS 200 ## Query Params | Parâmetro | Descrição | | ---------------------------- | ------------------------------------------------------------------------------------------ | | `page` | Página, a partir de 0 (default 0) | | `limit` | Itens por página (default 20, máximo 500) | | `issuance_serie_key` | Chave única da série de emissão | | `fund_class_document_number` | CNPJ do fundo da série | | `fund_class_name` | Parte do nome do fundo (sem diferenciar maiúsculas) | | `only_active` | `true` retorna só séries com cotas em circulação e status diferente de `settled` e `pending_first_integralization` (default `false`) | | `not_in_status` | Lista de status de série a excluir do resultado | Caso 01: Retorno com uma série de emissão ```json { "data": [ { "issuance_serie_key": "UUID", "name": "SERIE 1", "serie": 1, "status": "active", "internal_code": "FUNDOEX-SR1", "remuneration_type": "residual", "original_quota_value": 1.0, "current_quota_value": 1.0518, "current_number_of_quotas": 500000.0, "current_net_worth": 525900.0, "current_principal_value": 500000.0, "performance_fee_current_value": 0.0, "minimum_share_capital": 0.0, "operation_period_configuration": {}, "sub_class": { "name": "COTA SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "name": "FUNDO EXEMPLO", "short_name": "FUNDO EX", "fund_class_key": "UUID", "document_number": "11.222.333/0001-81", "accounting_date": "2025-01-10", "sub_type": "regular", "tax_classification": "long_term", "condominum_type": "open_ended", "prevent_payment": false, "manager": { "manager_key": "UUID", "document_number": "11.222.333/0001-81", "manager_name": "GESTORA EXEMPLO" }, "administrator": { "name": "QI DTVM", "administrator_key": "UUID", "document_number": "11.222.333/0001-81" } } }, "water_mark_events": [] } ], "limit": 20, "page": 0, "is_last_page": true } ``` ## Issuance Serie | Campo | Tipo | Descrição | | -------------------------------- | ------ | ------------------------------------------------------------------------- | | `issuance_serie_key` | string | Chave única da série | | `name` | string | Nome da série | | `serie` | number | Número da série | | `status` | string | `created`, `pending_first_integralization`, `active` ou `settled` | | `internal_code` | string | Código interno da série | | `remuneration_type` | string | `yield_curve` ou `residual` | | `original_quota_value` | number | Valor original da cota | | `current_quota_value` | number | Valor atual da cota (patrimônio ÷ cotas; o original se não houver cotas) | | `current_number_of_quotas` | number | Cotas em circulação | | `current_net_worth` | number | Patrimônio líquido atual | | `current_principal_value` | number | Principal atual | | `performance_fee_current_value` | number | Taxa de performance provisionada | | `minimum_share_capital` | number | Valor mínimo de aplicação | | `operation_period_configuration` | object | Prazos de cotização e pagamento de aplicação e resgate | | `interest_rate_type`, `pre_fixed`, `post_fixed` | — | Remuneração da série, quando houver | | `isin_code`, `external_id` | string | Quando preenchidos | | `sub_class` | object | Subclasse (`name`, `sub_class_key`, `subordination_level`) e `fund_class` | | `water_mark_events` | array | Eventos de marca d'água (taxa de performance) | O objeto `fund_class` tem os mesmos campos de [Consulta paginada de Fundos](/documentation/iaas/passivo/consultas/consultar_todos_fundos). ## Erros Esta consulta não tem erros de regra de negócio: filtros sem correspondência devolvem `data` vazio. Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de Fundos URL: /documentation/iaas/passivo/consultas/consultar_todos_fundos Lista as classes de fundo da gestora, com paginação. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_classes MÉTODO GET STATUS 200 ## Query Params | Parâmetro | Descrição | | ----------------- | ----------------------------------------------------------------------- | | `page` | Página, a partir de 0 (default 0) | | `limit` | Itens por página (default 50, máximo 500) | | `name` | Parte do nome ou do nome curto do fundo (sem diferenciar maiúsculas) | | `document_number` | CNPJ do fundo | | `fund_class_key` | Chave única do fundo | Caso 01: Retorno com apenas um fundo ```json { "data": [ { "name": "FUNDO EXEMPLO", "short_name": "FUNDO EX", "document_number": "11.222.333/0001-81", "fund_class_key": "UUID", "accounting_date": "2025-01-10", "sub_type": "regular", "tax_classification": "long_term", "condominum_type": "open_ended", "prevent_payment": false, "manager": { "manager_key": "UUID", "document_number": "11.222.333/0001-81", "manager_name": "GESTORA EXEMPLO" }, "administrator": { "name": "QI DTVM", "administrator_key": "UUID", "document_number": "11.222.333/0001-81" } } ], "limit": 50, "page": 0, "is_last_page": true } ``` ## Fund Class | Campo | Tipo | Descrição | | ----------------------------- | ------- | --------------------------------------------------------------- | | `fund_class_key` | string | Chave única do fundo | | `name` | string | Nome do fundo | | `short_name` | string | Nome curto do fundo | | `document_number` | string | CNPJ do fundo | | `accounting_date` | string | Data contábil atual do fundo | | `sub_type` | string | Subtipo do fundo: `regular` ou `cash` | | `tax_classification` | string | Classificação tributária | | `condominum_type` | string | Tipo de condomínio: `open_ended` (aberto) ou `close_ended` (fechado) | | `prevent_payment` | boolean | Indica se os pagamentos do fundo estão bloqueados | | `manager` | object | Gestora: `manager_key`, `document_number`, `manager_name` | | `administrator` | object | Administrador: `administrator_key`, `name`, `document_number` (quando houver) | | `integralization_account_key` | string | Conta de integralização (quando houver) | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | --------------------------------------------- | | 400 | `QIT000004` | A gestora da integração não foi encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Enviar Boletim de Subscrição Assinado URL: /documentation/iaas/passivo/controle_de_oferta/enviar_boletim_de_subscricao_assinado --- ## Introdução Este recurso tem como objetivo nos enviar a comprovação de assinatura do **boletim de subscrição** de um **investidor** a uma **oferta de cotas** de um fundo. :::caution Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Distribuidor**. Use a chave de API e o host do perfil Distribuidor: veja [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Input / Output: Como ***input*** devem ser enviadas as informações da subscrição, o UUID da **oferta de cotas** que o investidor subscreveu, o **método de assinatura** e, dependendo do método, o conteúdo necessário para validação. Segue abaixo exemplo. Como ***output*** será entregue o objeto completo do **boletim de subscrição** criado, incluindo a ***subscription_note_key***, que identifica o boletim. O boletim é criado já no status `active` (ou `sold_off`, se `remaining_subscription_note_value` for zero). ## Request ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/signed_subscription_note MÉTODO POST STATUS 201 ## Request body ```json title='Request Body' { "number_of_quotas": 500.0, "original_subscription_note_value": 50000.00, "start_date": "2026-01-15", "maturity_date": "2026-12-31", "quota_offering_key": "UUID", "transaction_type": "ted", "signature_method": "opt_in", "opt_in_hash" : "OPT_IN_HASH" } ``` | Campo | Tipo | Descrição | Obrigatório | |-------------------------------------|--------|------------------------------------------------------------------------------------------------------------|-------------| | `original_subscription_note_value` | number | Valor do boletim. Mínimo 0. Não pode exceder o valor restante da oferta | Sim | | `quota_offering_key` | string | UUID da oferta de cotas. A oferta deve estar `active`, com valor restante e sem aditamento pendente | Sim | | `transaction_type` | string | `ted` ou `b3` | Sim | | `signature_method` | string | Método de assinatura usado. Com `opt_in`, envie `opt_in_hash`; com qualquer outro método, envie `document_b64` | Sim | | `opt_in_hash` | string | Hash do opt-in (até 250 caracteres) | Não | | `document_b64` | string | Boletim assinado codificado em base64 | Não | | `number_of_quotas` | number | Quantidade de cotas do boletim | Não | | `remaining_subscription_note_value` | number | Saldo restante do boletim. Não pode ser maior que `original_subscription_note_value` | Não | | `start_date` | string | Data inicial (`YYYY-MM-DD`). Se omitida, usa a data atual (UTC) | Não | | `maturity_date` | string | Data de vencimento (`YYYY-MM-DD`). Não pode estar no passado | Não | :::caution Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: ## Response A resposta tem o mesmo formato da resposta de [Solicitar Boletim de Subscrição](/documentation/iaas/passivo/controle_de_oferta/solicitar_boletim_de_subscricao#response). ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------------------------------- | | 400 | `QOF000020` | `maturity_date` está no passado | | 400 | `QOF000026` | O valor do boletim é maior que o valor restante da oferta | | 400 | `QOF000046` | `transaction_type` inválido | | 400 | `QOF000047` | A classificação do investidor não permite subscrever a oferta | | 400 | `QOF000068` | `signature_method` inválido | | 400 | `QOF000069` | `signature_method` é `opt_in` e `opt_in_hash` não foi enviado | | 400 | `QOF000072` | `signature_method` não é `opt_in` e `document_b64` não foi enviado | | 400 | `QOF000150` | `remaining_subscription_note_value` é maior que `original_subscription_note_value` | | 400 | `QIT000004` | A integração não é a distribuidora do investidor | | 404 | `QOF000017` | Investidor não encontrado | | 404 | `QOF000019` | Oferta de cotas não encontrada | | 404 | `QOF000039` | A oferta não está ativa, está vencida ou não tem valor restante | | 409 | `QOF000152` | A oferta tem um aditamento aguardando aprovação | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Recuperando Informações sobre Boletim de Subscrição URL: /documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao --- Lista os **boletins de subscrição** de um investidor ou de uma classe de fundo, de forma paginada. ## Request ### Boletins de um investidor :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/subscription_notes MÉTODO GET STATUS 200 A gestora recebe apenas os boletins de ofertas de fundos que ela gere. | Query param | Descrição | |------------------------------|-------------------------------------------------------------------------------------------------| | `limit` | Itens por página. Padrão 50, máximo 500 | | `page` | Página, começando em 0. Padrão 0 | | `status` | Filtra por status. Aceita mais de um valor, separados por vírgula | | `issuance_serie_key` | Filtra pela série de emissão | | `fund_class_document_number` | Filtra pelo CNPJ da classe de fundo | | `financial_application_key` | Filtra pela aplicação financeira | | `quotation_date` | Com `status=sold_off`, retorna os boletins esgotados nessa data (`YYYY-MM-DD`) | ### Boletins de uma classe de fundo :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ENDPOINT /quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes MÉTODO GET STATUS 200 | Query param | Descrição | |----------------------------|-------------------------------------------------------------------------------| | `limit` | Itens por página. Padrão 50, máximo 500 | | `page` | Página, começando em 0. Padrão 0 | | `status` | Filtra por status. Aceita mais de um valor, separados por vírgula | | `investor_key` | Filtra pelo investidor | | `investor_document_number` | Filtra pelo CPF/CNPJ do investidor | ## Responses Caso 01: Investidor com um Boletim de Subscrição ```json { "data":[ { "subscription_note_key":"UUID", "quota_offering":{ "quota_offering_key":"UUID", "status":"active / closed", "original_quota_offering_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_quota_offering_value":0.00, "start_date":"YYYY-MM-DD", "issuance_serie":{ "name":"1", "issuance_serie_key":"UUID", "sub_class":{ "name":"SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "fund_class_key":"UUID", "name":"SAMPLE FUND CLASS NAME", "document_number":"00.000.000/0000-00", "short_name":"SAMPLE FUND CLASS SHORT NAME" } }, "classification":"general / qualified / professional", "market_type":"primary / secondary" }, "type":"public / private", "subscription_note_template_key":"UUID", "subscription_note_generation_type":"internal / external", "regulatory_type":"exclusive_fund", "cvm_registration":{ "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" }, "lead_coordinator":{ "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" }, "status_events":[ { "status":"active", "event_datetime":"YYYY-MM-DD HH:MM:SS" } ] }, "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"Sample Distributor Name" }, "investor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person" }, "status":"active", "transaction_type":"b3 / ted", "signature_method":"certifiqi / qi_sign / opt_in / external", "original_subscription_note_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_subscription_note_value":0.00, "total_assignment_value":0.00, "start_date":"YYYY-MM-DD", "financial_application_events":[ { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"consume_value", "share_capital":0.00, "event_datetime":"YYYY-MM-DD HH:MM:SS" }, { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"update_quotas", "number_of_quotas":0.00, "event_datetime":"YYYY-MM-DD HH:MM:SS" }, { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"cancel", "event_datetime":"YYYY-MM-DD HH:MM:SS" } ], "status_events":[ { "status":"created", "event_datetime":"YYYY-MM-DD HH:MM:SS" }, { "status":"active", "event_datetime":"YYYY-MM-DD HH:MM:SS" } ] } ], "limit":50, "page":0, "is_last_page":true } ``` Caso 02: Investidor sem Boletim de Subscrição ```json { "data":[], "limit":50, "page":0, "is_last_page":true } ``` ## Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Subscription Note](#subscription-note)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ## Subscription Note | Campo | Tipo | Descrição | |---------------------------|----------|-------------------------------------------------------------------------------------------------------| | `subscription_note_key` | string | Chave única de identificação do boletim de subscrição | | `quota_offering` | JSON | Objeto de **[Quota Offering](#quota-offering)** | | `investor` | JSON | Objeto de **[Investor](#investor)** | | `status` | string | Status do boletim. Ver **[Subscription Note Status](#subscription-note-status)** | | `signature_method` | string | `certifiqi` / `qi_sign` / `opt_in` / `external` | | `total_assignment_value` | float | Valor total cedido do boletim | | `status_events` | array | Histórico de status (`status`, `event_datetime`) | | `transaction_type` | string | `ted` / `b3` | | `original_subscription_note_value` | float | Valor original do boletim de subscrição | | `issued_number_of_quotas` | float | Quantidade de cotas emitidas | | `remaining_subscription_note_value` | float | Valor restante do boletim de subscrição | | `start_date` | string | Data inicial do boletim de subscrição | | `financial_application_events`| array | Lista de objetos de **[Financial Application Event](#financial-application-event)** | | `maturity_date` | string | Data de vencimento. Ausente quando não preenchida | | `original_number_of_quotas`| float | Quantidade original de cotas. Ausente quando não preenchida | ## Subscription Note Status | Enumerador | Descrição | |-----------------------------|-----------------------------------------------| | `created` | Criado | | `pending_batch_close` | Aguardando fechamento do lote | | `send_to_generate_document` | Enviado para geração do documento | | `pending_document` | Aguardando documento | | `pending_manual_inputs` | Aguardando dados manuais (geração externa) | | `pending_signature` | Aguardando assinatura | | `active_without_signature` | Ativo sem assinatura | | `active` | Ativo | | `sold_off` | Esgotado | | `processing_cancellation` | Em cancelamento | | `canceled` | Cancelado | | `processing_expired` | Em expiração | | `expired` | Expirado | ## Quota Offering O objeto `quota_offering` tem os mesmos campos da resposta de [Informações das ofertas](/documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas#quota-offering), inclusive os objetos aninhados `issuance_serie`, `sub_class` e `fund_class`. ## Financial Application Event | Campo | Tipo | Descrição | |-----------------------------------|----------|-----------------------------------------------------------------------------------------| | `financial_application_key` | string | Chave única de identificação da aplicação financeira | | `financial_application_event_key` | string | Chave única de identificação do evento da aplicação financeira | | `type` | string | Consumir valor / Atualizar cotas / Cancelar | | `event_datetime` | string | Data e hora do evento | | `share_capital` | float | Valor do aporte da aplicação financeira. Só aparece quando `type` é `consume_value` | | `number_of_quotas` | float | Número de cotas da aplicação financeira. Só aparece quando `type` é `update_quotas` | ## Investor | Campo | Tipo | Descrição | |--------------------------|----------|---------------------------------------------------| | `name` | string | Nome do investidor | | `investor_key` | string | Chave única de identificação do investidor | | `document_number` | string | CPF/CNPJ do investidor | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | ## Distributor | Campo | Tipo | Descrição | |--------------------------|----------|---------------------------------------------------| | `name` | string | Nome do distribuidor | | `distributor_key` | string | Chave única de identificação do distribuidor | | `document_number` | string | CPF/CNPJ do distribuidor | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ----------------------------------------------------------------------- | | 400 | `QIT000004` | A classe de fundo não é gerida pela gestora | | 404 | `QOF000007` | Classe de fundo não encontrada | | 404 | `QOF000017` | Investidor não encontrado | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Recuperando Informações sobre as Ofertas URL: /documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas --- Lista as **ofertas de cotas** de uma classe de fundo, de forma paginada. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_offering_control/fund_class/FUND_CLASS_KEY/quota_offerings MÉTODO GET STATUS 200 ## Query Params | Parâmetro | Descrição | |----------------------|------------------------------------------------------------------------------------------------------------| | `limit` | Itens por página. Padrão 50, máximo 500 | | `page` | Página, começando em 0. Padrão 0 | | `sub_class_key` | Chave única de identificação da sub classe | | `issuance_serie_key` | Chave única de identificação da série de emissão | | `showOffers` | `active`: só ofertas ativas com valor restante. `closed`: ofertas fechadas ou com vencimento no passado | ## Responses Caso 01: Fundo com uma Oferta ```json { "data":[ { "quota_offering_key":"UUID", "status":"active", "original_quota_offering_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_quota_offering_value":0.00, "start_date":"YYYY-MM-DD", "issuance_serie":{ "name":"1", "issuance_serie_key":"UUID", "sub_class":{ "name":"SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "fund_class_key":"UUID", "name":"SAMPLE FUND CLASS NAME", "document_number":"00.000.000/0000-00", "short_name":"SAMPLE FUND CLASS SHORT NAME" } }, "classification":"general / qualified / professional", "market_type":"primary / secondary" }, "type":"public / private", "subscription_note_template_key":"UUID", "subscription_note_generation_type":"internal / external", "regulatory_type":"exclusive_fund", "cvm_registration":{ "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" }, "lead_coordinator":{ "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" }, "status_events":[ { "status":"active", "event_datetime":"YYYY-MM-DD HH:MM:SS" } ] } ], "limit":50, "page":0, "is_last_page":true } ``` Caso 02: Fundo sem uma Oferta ```json { "data":[], "limit":50, "page":0, "is_last_page":true } ``` ## Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Quota Offering](#quota-offering)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ## Quota Offering | Campo | Tipo | Descrição | |-----------------------------------|----------|-----------------------------------------------------------------------------------------| | `quota_offering_key` | string | Chave única de identificação da oferta | | `status` | string | `created` / `active` / `processing_closing` / `pending_closing_at_cvm` / `pending_closing_at_anbima` / `pending_divulgation` / `closed` | | `subscription_note_generation_type` | string | `internal` (documento gerado pela QI) / `external` | | `subscription_note_template_key` | string | Chave do modelo do boletim de subscrição | | `regulatory_type` | string | Tipo regulatório da oferta | | `status_events` | array | Histórico de status (`status`, `event_datetime`) | | `original_quota_offering_value` | float | Valor original da oferta | | `issued_number_of_quotas` | float | Quantidade de cotas subscritas | | `remaining_quota_offering_value` | float | Valor restante da oferta | | `start_date` | string | Data inicial da oferta | | `issuance_serie` | string | Objeto de **[Issuance Serie](#issuance-serie)** | | `type` | string | Tipo da oferta pública/privada | | `cvm_registration` | JSON | Dados do registro CVM. Ausente quando não preenchido | | `lead_coordinator` | JSON | Dados do coordenador líder. Ausente quando não preenchido | | `maturity_date` | string | Data de vencimento. Ausente quando não preenchida | | `original_number_of_quotas` | float | Quantidade original de cotas. Ausente quando não preenchida | cvm_registration ```json { "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" } ``` lead_coordinator ```json { "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" } ``` ## Issuance Serie | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da série de emissão | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `sub_class` | JSON | Objeto de **[Sub Class](#sub-class)** | | `classification` | string | Profissional / Qualificado / Geral | | `market_type` | string | Primário / Secundário | | `serie` | integer | Número sequencial da série de emissão dentro da sub classe (1, 2, 3...). Não se repete na mesma sub classe | ## Sub Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da sub classe | | `sub_class_key` | string | Chave única de identificação da sub classe | | `subordination_level` | int | Nível de subordinação da sub classe | | `fund_class` | JSON | Objeto de **[Fund Class](#fund-class)** | ## Fund Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da classe de fundo | | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `short_name` | string | Nome reduzido da classe de fundo | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------------------- | | 400 | `QIT000004` | A classe de fundo não é gerida pela gestora | | 404 | `QOF000007` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Solicitar Boletim de Subscrição URL: /documentation/iaas/passivo/controle_de_oferta/solicitar_boletim_de_subscricao --- ## Introdução Este recurso tem como objetivo criar uma solicitação de **boletim de subscrição** de um **investidor** a uma **oferta de cotas** de um fundo. A partir desta solicitação, o documento do boletim é gerado de acordo com o tipo de geração configurado na oferta. ## Input / Output: Como ***input*** deve ser enviado o UUID da **oferta de cotas** em que o investidor está subscrevendo, o **valor do boletim**, o **tipo de transação** e, opcionalmente, o método de assinatura e o grupo de signatários. Segue abaixo exemplo. Como ***output*** será entregue o objeto completo do **boletim de subscrição** criado, incluindo a ***subscription_note_key***. A ***subscription_note_key*** é utilizada para identificar o **boletim de subscrição**. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Escrita | A oferta precisa ser de um fundo da gestora. URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/subscription_note MÉTODO POST STATUS 201 ## Path Params | Parâmetro | Descrição | |-------------------|-----------------------| | `INVESTOR_KEY` | UUID do investidor | ## Request body ```json title='Request Body' { "original_subscription_note_value": 50000.00, "quota_offering_key": "UUID", "transaction_type": "ted", "signature_method": "certifiqi", "signer_group_key": "UUID" } ``` ## Subscription Note | Campo | Tipo | Descrição | Obrigatório | |------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------| | `original_subscription_note_value` | number | Valor do boletim de subscrição. Mínimo 0. Não pode exceder o valor restante da oferta | Sim | | `quota_offering_key` | string | UUID (36 caracteres) da oferta de cotas. A oferta deve existir e estar com status `active` | Sim | | `transaction_type` | string | `ted` ou `b3`. Para `b3`, a classe de fundo precisa ter conta B3 cadastrada | Sim | | `signature_method` | string | Enumerador do método de assinatura. Se omitido, o serviço define pelo tipo de pessoa: `natural_person` → `qi_sign`, `legal_person` → `certifiqi` | Não | | `signer_group_key` | string | UUID (36 caracteres) do grupo de signatários. Se omitido, usa o grupo de signatários default do investidor | Não | | `number_of_quotas` | number | Quantidade de cotas do boletim. Mínimo 0 | Não | | `start_date` | string | Data inicial do boletim (`YYYY-MM-DD`). Se omitida, usa a data atual (UTC) | Não | | `maturity_date` | string | Data de vencimento do boletim (`YYYY-MM-DD`). Não pode estar no passado | Não | ## Signature Method | Enumerador | Descrição | |---------------|--------------------------------------------------------------| | `certifiqi` | Assinatura via CertifiQi (Certificado Digital) | | `qi_sign` | Assinatura via QI Sign (Assinatura Eletrônica) | ## Response ```json title='Response Body' { "subscription_note_key": "UUID", "status": "send_to_generate_document", "original_number_of_quotas": 500, "original_subscription_note_value": 50000.00, "issued_number_of_quotas": 0, "remaining_subscription_note_value": 50000.00, "total_assignment_value": 0.00, "start_date": "YYYY-MM-DD", "transaction_type": "ted", "signature_method": "certifiqi", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "11.222.333/0001-81", "name": "SAMPLE DISTRIBUTOR NAME" }, "investor_key": "UUID", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person", "document_number": "00.000.000/0000-00" }, "quota_offering": { "quota_offering_key": "UUID", "status": "active", "original_quota_offering_value": 10000000.00, "issued_number_of_quotas": 25000.00, "remaining_quota_offering_value": 7500000.00, "start_date": "YYYY-MM-DD", "issuance_serie": { "name": "1", "issuance_serie_key": "UUID", "external_id": "SERIE-001", "sub_class": { "name": "SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "fund_class_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE FUND CLASS NAME", "short_name": "SAMPLE FUND CLASS SHORT NAME", "manager": { "name": "SAMPLE MANAGER NAME", "manager_key": "UUID", "document_number": "00.000.000/0000-00" }, "administrator": { "name": "SAMPLE ADMINISTRATOR NAME", "administrator_key": "UUID", "document_number": "00.000.000/0000-00", "data": {} }, "b3_account": "123456" } }, "classification": "general / qualified / professional", "market_type": "primary / secondary", "serie": 1, "issuance_serie_configuration": {} }, "type": "public / private", "subscription_note_template_key": "UUID", "subscription_note_generation_type": "internal / external", "regulatory_type": "exclusive_fund", "maturity_date": "YYYY-MM-DD", "status_events": [ { "status": "created", "event_datetime": "YYYY-MM-DD HH:MM:SS" }, { "status": "active", "event_datetime": "YYYY-MM-DD HH:MM:SS" } ] }, "financial_application_events": [], "status_events": [ { "status": "created", "event_datetime": "YYYY-MM-DD HH:MM:SS" }, { "status": "send_to_generate_document", "event_datetime": "YYYY-MM-DD HH:MM:SS" } ] } ``` A descrição detalhada dos objetos **[Quota Offering](/documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas#quota-offering)**, **[Investor](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao#investor)** e **[Financial Application Event](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao#financial-application-event)** pode ser consultada na página **[Informações sobre Boletim de Subscrição](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao)**. O boletim é criado no status `send_to_generate_document` quando a oferta gera o documento internamente (`subscription_note_generation_type: internal`) e em `pending_manual_inputs` quando a geração é externa. `maturity_date` e `original_number_of_quotas` só aparecem na resposta quando preenchidos. ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ---------------------------------------------------------------------------------------------------- | | 400 | `QIT000004` | A oferta não é de um fundo da gestora | | 400 | `QOF000020` | `maturity_date` está no passado | | 400 | `QOF000026` | O valor do boletim é maior que o valor disponível da oferta | | 400 | `QOF000043` | Cadastro do investidor não encontrado | | 400 | `QOF000046` | `transaction_type` diferente de `ted` ou `b3` | | 400 | `QOF000047` | A classificação do investidor não permite subscrever a oferta | | 400 | `QOF000076` | O investidor já tem dois boletins ativos nessa oferta | | 400 | `QOF000082` | O cadastro do investidor está desatualizado | | 400 | `QOF000090` | O investidor já tem um boletim ativo sem assinatura na série da oferta | | 400 | `QOF000103` | O investidor não possui grupo de signatários (ou o `signer_group_key` não existe) | | 400 | `QOF000104` | A oferta é exclusiva e o investidor não está entre os investidores permitidos | | 400 | `QOF000130` | O investidor está com o cadastro não operacional | | 404 | `QOF000017` | Investidor não encontrado | | 404 | `QOF000019` | Oferta de cotas não encontrada | | 404 | `QOF000039` | A oferta não está ativa, está vencida ou não tem valor restante | | 404 | `QOF000053` | `transaction_type` é `b3` e a classe de fundo não tem conta B3 cadastrada | | 404 | `QOF000073` | `signature_method` não encontrado | | 409 | `QOF000025` | O investidor já tem um boletim aguardando assinatura na série da oferta | | 409 | `QOF000152` | A oferta tem um aditamento aguardando aprovação | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Recuperando Cotas Públicas URL: /documentation/iaas/passivo/fundos/cotas_publicas Retorna os valores de cota aprovados e públicos das séries de emissão, por data de referência. É uma consulta pública: não exige chave de API nem assinatura da requisição. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------------ | --------------------------------- | | Público | `api.qidtvm.com.br` | Nenhuma (não exige chave de API) | O host público atende apenas **produção**. URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /public_dash/mark_to_market/fund_quota/mark_to_markets MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Tipo | Descrição | |-----------------------------|----------|---------------------------------------------------------------------------------------| | `internal_codes` | list | Lista de códigos internos da série de emissão (separados por vírgula ou com o parâmetro repetido) | | `from_reference_date` | string | Data de início do período a ser consultado (YYYY-MM-DD) | | `to_reference_date` | string | Data do fim do período a ser consultado (YYYY-MM-DD) | | `internal_code` | string | Código único da série de emissão a ser consultada | | `fund_class_document_number`| string | CNPJ (com pontuação) do fundo a ser consultado | | `limit` | int | Itens por página: de 1 a 400 (default 10) | | `page` | int | Página, a partir de 0 (default 0) | Só são retornados valores de cota com status aprovado e marcados como públicos. :::caution Atenção O valor de cota se encontra a nível de **série de emissão (issuance_serie)** e portanto o uso do parâmetro **fund_class_document_number** implica no retorno de todas as séries. Recomenda-se o uso desse filtro apenas para o mapeamento de identificadores únicos das séries de emissão (**internal_code** e **issuance_serie_key**). ::: ## Response ```json title='Response Body' { "data": [ { "issuance_serie_key": "1de4125b-48c7-40ca-b97b-0b65fb356468", "internal_code": "INTERNAL-CODE-2", "fund_class_document_number": "11.222.333/0001-81", "fund_class_name": "FUNDO DE INVESTIMENTO DE TESTES", "marks_to_market": [ { "reference_date": "2025-09-05", "before_amortization_unit_price": 1000, "unit_price": 1000 } ] }, { "issuance_serie_key": "71f7ee44-388d-4916-b068-647e82fd67c8", "internal_code": "INTERNAL-CODE-1", "fund_class_document_number": "11.222.333/0001-81", "fund_class_name": "FUNDO DE INVESTIMENTO DE TESTES", "marks_to_market": [ { "reference_date": "2025-09-04", "before_amortization_unit_price": 1000, "unit_price": 1000 } ] } ], "limit": 5, "page": 0, "is_last_page": true } ``` ### Issuance Serie | Campo | Tipo | Descrição | |-----------------------------------|--------|--------------------------------------------------------------| | `issuance_serie_key` | string | Chave que identifica a série de emissão | | `internal_code` | string | Código que identifica a série de emissão internamente | | `fund_class_document_number` | string | CNPJ do fundo de investimento consultado | | `fund_class_name` | string | Nome do fundo de investimento consultado | | `marks_to_market` | array | Lista de objetos de **[Marks To Market](#marks-to-market)** | ### Marks To Market | Campo | Tipo | Descrição | |-----------------------------------|--------|--------------------------------------------------------------| | `reference_date` | string | Data do valor de cota da série de emissão (YYYY-MM-DD) | | `before_amortization_unit_price` | float | O valor da cota da série de emissão antes de uma amortização | | `unit_price` | float | O valor da cota da série de emissão após o fechamento | ## Erros | Status | Código | Quando acontece | | ------ | ------ | ------------------------------------------------------------------ | | 400 | — | `limit` fora do intervalo de 1 a 400, `page` negativo ou data em formato inválido | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Introdução URL: /documentation/iaas/passivo/inicio Bem-vindo à documentação de integração para operações relacionadas ao **Passivo**. Nesta seção, apresentamos todas as ferramentas e recursos necessários para interagir com os serviços oferecidos, desde o cadastro de investidores até a execução de operações financeiras. ## Visão Geral A API de Passivo oferece um conjunto de funcionalidades para facilitar a gestão e execução de operações financeiras para fundos de investimento. Com ela, é possível realizar o cadastro de investidores, aplicações financeiras, pedidos de resgate, bloqueio de cotas e outras operações essenciais para o gerenciamento de ativos. Os serviços são disponibilizados por meio de endpoints que permitem a comunicação segura e eficiente entre as aplicações dos clientes e a plataforma. ### Acesso aos Serviços Para obter acesso aos serviços, é necessário realizar as liberações necessárias nos ambientes de sandbox e produção. Entre em contato com o time de integração pelo e-mail [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br) para solicitar as credenciais de acesso e receber orientações sobre o processo de ativação. ## Recursos Disponíveis ### Cadastro do Investidor - **Criar investidor / análise do investidor**: Permite o cadastro de um investidor e a análise cadastral inicial. Descrito em: [5.9.2.1 Criar investidor](/documentation/iaas/investidor/cadastro/criar_investidor) - **Buscar informações do investidor**: Consulta informações cadastrais de um investidor. Descrito em: [5.9.2.2 Buscar informações do investidor](/documentation/iaas/investidor/cadastro/busca_informacoes_do_investidor) - **Buscar informações de uma análise cadastral do investidor**: Permite consultar o status da análise cadastral de um investidor. Descrito em: [5.9.2.3 Buscar análise cadastral](/documentation/iaas/investidor/cadastro/busca_informacoes_de_uma_analise_cadastral_do_investidor) - **Enviar dados cadastrais**: Envia dados cadastrais complementares para análise. Descrito em: [5.9.2.4 Enviar dados cadastrais](/documentation/iaas/investidor/cadastro/enviar_dados_cadastrais) ### Aplicação Financeira - **Criar Aplicação Financeira**: Permite criar uma aplicação financeira em uma série de emissão. Descrito em: [5.9.5.1 Criar Aplicação Financeira](/documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira) - **Consultar Aplicação Financeira**: Permite consultar aplicações financeiras por chave ou através de busca paginada. Descrito em: [5.9.5.2 Consulta por chave](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave) e [5.9.5.3 Consulta paginada](/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras) ### Pedido de Resgate - **Criar Pedido de Resgate**: Permite criar um pedido de resgate para um investidor. Descrito em: [5.9.6.1 Criar Pedido de Resgate](/documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate) - **Consultar Pedido de Resgate**: Consulta pedidos de resgate por chave ou através de busca paginada. Descrito em: [5.9.6.2 Consulta por chave](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave), [5.9.6.3 Consulta paginada por investidor](/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor) e [5.9.6.4 Consulta paginada por classe de fundo](/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo) ### Bloqueio de Cotas - **Solicitar Bloqueio de Cotas**: Permite solicitar o bloqueio de cotas para garantia. Descrito em: [5.9.8.1 Solicitar Bloqueio de Cotas](/documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas) - **Consultar Bloqueios de Cotas**: Consulta bloqueios de cotas por investidor ou de forma paginada. Descrito em: [5.9.8.2 Consultar bloqueios de cotas](/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas) ## Conclusão Essa documentação serve como guia completo para integração e utilização dos serviços de Passivo. Em caso de dúvidas, entre em contato com nossa equipe de suporte pelo e-mail [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br). --- # Consulta paginada de negociações em mercado secundário URL: /documentation/iaas/passivo/mercado_secundario/consulta_negociacoes_mercado_secundario Endpoint de consulta paginada que retorna as **negociações de cotas em mercado secundário** de uma classe de fundo. Cada registro representa a transferência de uma quantidade de cotas de um cotista vendedor para um cotista comprador, com o valor de cota praticado na negociação e a tributação retida do vendedor. Cada negociação relaciona três aplicações financeiras: | Papel | Descrição | |---|---| | `sold_financial_application` | Aplicação do **vendedor**, da qual as cotas saíram. É por ela que os filtros de classe de fundo, série, investidor e depositária central são aplicados. | | `new_financial_application` | Aplicação criada para o **comprador**, com `financial_application_type` igual a `secondary_market`. | | `original_financial_application` | Aplicação que **originou a posição** no mercado primário. Em revendas sucessivas, a mesma aplicação original é propagada para todas as negociações da cadeia, permitindo rastrear a entrada original das cotas. | :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/secondary_market_trades MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Quantidade de registros por página. Padrão: `50`. Máximo: `500`. | | `issuance_serie_key` | string | opcional | Filtra pelas negociações da série de emissão informada. | | `investor_key` | string | opcional | Filtra pelas negociações em que o investidor informado é o **vendedor**. | | `sold_financial_application_key` | string | opcional | Filtra pela aplicação financeira de origem das cotas negociadas. | | `central_depositary` | string | opcional | Filtra pela depositária central da aplicação de origem. Valores: `cetip` (cotas depositadas na B3) ou `unregistered` (cotas não depositadas). | Os registros são retornados em ordem cronológica de criação da negociação. ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/secondary_market_trades?page=0&limit=50&issuance_serie_key=c3d4e5f6-a7b8-9012-cdef-123456789012¢ral_depositary=cetip ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "secondary_market_trade_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "original_financial_application": { "financial_application_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "share_capital": 500000.0, "status": "quoted", "redemption_keys": [ { "redemption_key": "c3d4e5f6-a7b8-9012-cdef-123456789012" } ], "financial_application_type": "primary_market", "original_number_of_quotas": 500000.0, "current_principal_value": 490000.0, "acquisition_cost": 500000.0, "current_number_of_quotas": 490000.0, "quotation_date": "2026-03-02", "payment_method": "b3", "investor_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "issuance_serie_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "external_id": "ext-fa-001" }, "sold_financial_application": { "financial_application_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "share_capital": 500000.0, "status": "quoted", "redemption_keys": [ { "redemption_key": "c3d4e5f6-a7b8-9012-cdef-123456789012" } ], "financial_application_type": "primary_market", "original_number_of_quotas": 500000.0, "current_principal_value": 490000.0, "acquisition_cost": 500000.0, "current_number_of_quotas": 490000.0, "quotation_date": "2026-03-02", "payment_method": "b3", "investor_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "issuance_serie_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "external_id": "ext-fa-001" }, "new_financial_application": { "financial_application_key": "f6a7b8c9-d0e1-2345-f012-456789012345", "share_capital": 10523.45, "status": "quoted", "redemption_keys": [], "financial_application_type": "secondary_market", "original_number_of_quotas": 10000.0, "current_principal_value": 1.05234567, "acquisition_cost": 1.05234567, "current_number_of_quotas": 10000.0, "quotation_date": "2026-03-02", "payment_method": "b3", "investor_key": "a7b8c9d0-e1f2-3456-0123-567890123456", "issuance_serie_key": "e5f6a7b8-c9d0-1234-ef01-345678901234" }, "trade_quota_value": 1.05234567, "number_of_quotas": 10000.0, "event_datetime": "2026-07-31 00:00:00", "taxable_yield_value": 523.45, "ir_value": 78.52, "iof_value": 0.0 } ], "limit": 50, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de negociações da classe de fundo. | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página solicitado. | | `is_last_page` | boolean | Indica se não há mais registros após esta página. | #### Objeto em `data` | Campo | Tipo | Descrição | |---|---|---| | `secondary_market_trade_key` | string | Chave única da negociação. | | `original_financial_application` | object | Aplicação financeira que originou a posição no mercado primário. | | `sold_financial_application` | object | Aplicação financeira do vendedor, de onde saíram as cotas. | | `new_financial_application` | object | Aplicação financeira criada para o comprador. | | `trade_quota_value` | number | Valor de cota praticado na negociação. | | `number_of_quotas` | number | Quantidade de cotas negociadas. | | `event_datetime` | string | Data e hora do evento de negociação. | | `taxable_yield_value` | number | Rendimento tributável apurado para o vendedor na negociação. Omitido quando não apurado. | | `ir_value` | number | Imposto de renda retido do vendedor. Omitido quando não apurado. | | `iof_value` | number | IOF retido do vendedor. Omitido quando não apurado. | #### Objeto de aplicação financeira | Campo | Tipo | Descrição | |---|---|---| | `financial_application_key` | string | Chave única da aplicação financeira. | | `share_capital` | number | Valor aportado na aplicação. | | `status` | string | Situação da aplicação, por exemplo `quoted`, `settled`, `redeemed`. | | `redemption_keys` | array | Chaves dos resgates associados à aplicação. Na aplicação do vendedor inclui o resgate gerado pela negociação. | | `financial_application_type` | string | `primary_market` ou `secondary_market`. | | `original_number_of_quotas` | number | Quantidade de cotas na criação da aplicação. | | `current_number_of_quotas` | number | Quantidade de cotas atual. | | `current_principal_value` | number | Valor principal atual. | | `acquisition_cost` | number | Custo de aquisição. | | `quotation_date` | string | Data de cotização. | | `payment_method` | string | Forma de liquidação, por exemplo `b3` ou `regular`. | | `investor_key` | string | Chave do investidor titular da aplicação. | | `issuance_serie_key` | string | Chave da série de emissão da aplicação. | | `external_id` | string | Identificador externo, quando informado no cadastro da aplicação. | Campos opcionais são omitidos da resposta quando não houver valor. Para consultar as aplicações financeiras em detalhe, consulte [Consulta paginada de aplicações financeiras](/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras). ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------- | | 400 | `QIT000004` | O fundo não é da gestora da integração | | 404 | `QTA000002` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consultar Pedido de Resgate por chave URL: /documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave Retorna um pedido de resgate de um investidor pela chave. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | -------------------------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/investor/INVESTOR_KEY/redemption_request/REDEMPTION_REQUEST_KEY MÉTODO GET STATUS 200 A gestora só consulta pedidos de resgate de fundos dela. ## Responses Caso 01: Consulta bem-sucedida ```json { "redemption_request_key": "UUID", "redemption_request_type": "gross_redemption_value", "status": "quoted", "quotation_date": "2025-01-15", "payment_date": "2025-01-16", "payment_method": "regular", "request_datetime": "2025-01-14T13:05:00Z", "redemption_request_data": { "gross_redemption_value": 1000.0 }, "processed_value": 1000.0, "ir_value": 2.78, "iof_value": 0.0, "investor": { "investor_key": "UUID", "name": "INVESTIDOR EXEMPLO", "person_type": "natural_person", "document_number": "969.698.790-03", "distributor": { "distributor_key": "UUID", "document_number": "11.222.333/0001-81", "name": "DISTRIBUIDORA EXEMPLO", "account_data": {} } }, "issuance_serie": { "issuance_serie_key": "UUID", "name": "SERIE 1", "sub_class": { "name": "COTA SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "name": "FUNDO EXEMPLO", "fund_class_key": "UUID", "document_number": "11.222.333/0001-81" } } }, "payments": [ { "payment_key": "UUID", "origin_key": "UUID", "total_value": 997.22, "payment_type": "redemption.investor", "payment_date": "2025-01-16", "status": "paid" } ], "status_events": [ { "status": "pending_quote", "event_datetime": "2025-01-14T13:05:00Z" }, { "status": "quoted", "event_datetime": "2025-01-15T21:00:00Z" } ] } ``` ### Redemption Request {#redemption_request} | Campo | Tipo | Descrição | | ------------------------- | ------ | ---------------------------------------------------------------------------- | | `redemption_request_key` | string | Chave única do pedido de resgate | | `redemption_request_type` | string | Enumerador de **[Redemption Request Type](#redemption_request_type)** | | `status` | string | Enumerador de **[Redemption Request Status](#redemption_request_status)** | | `quotation_date` | string | Data de cotização | | `payment_date` | string | Data de pagamento | | `payment_method` | string | `regular` ou `b3` | | `request_datetime` | string | Data e hora da criação do pedido (UTC) | | `redemption_request_data` | object | Valores enviados na criação (ex.: `gross_redemption_value`, `net_value`) | | `processed_value` | float | Valor processado do resgate | | `ir_value` | float | IR do resgate | | `iof_value` | float | IOF do resgate | | `investor` | object | Investidor: `investor_key`, `name`, `person_type`, `document_number` e `distributor` | | `issuance_serie` | object | Série de emissão, com `sub_class` e `sub_class.fund_class` | | `payments` | array | Pagamentos gerados (investidor, IR, IOF): `payment_key`, `origin_key`, `total_value`, `payment_type`, `payment_date`, `status`, `status_events` | | `status_events` | array | Histórico de status: `status` e `event_datetime` (UTC) | | `cancellation_data` | object | Dados do cancelamento, só quando o pedido foi cancelado | ### Redemption Request Type {#redemption_request_type} | Enumerador | Descrição | | ----------------------------- | -------------------------------- | | `gross_redemption_value` | Resgate por valor bruto | | `number_of_quotas` | Resgate por número de cotas | | `remaining_application_value` | Resgate por posição remanescente | | `net_value_redemption` | Resgate por valor líquido | ### Redemption Request Status {#redemption_request_status} | Enumerador | Descrição | | ----------------------------------- | ---------------------------------------------- | | `created` | Criado | | `pending_manager_approval` | Aguardando aprovação da gestora | | `pending_quote` | Pendente de cotização | | `processing_quotation` | Cotização em processamento | | `pending_quotation_date_input` | Aguardando definição da data de cotização | | `processing_issuance_serie_impacts` | Processando impactos na série | | `quoted` | Cotizado | | `canceled` | Cancelado | | `reprocessed` | Reprocessado | ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ----------------------------------------------------- | | 400 | `QIT000004` | O pedido de resgate não é de um fundo da gestora | | 404 | `QTA000036` | Pedido de resgate não encontrado para o investidor | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de pedidos de resgate por classe de fundo URL: /documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo Lista **pedidos de resgate** de uma **classe de fundo** da gestora (`fund_class_key`), com paginação e filtros opcionais. :::info Disponível em | Perfil | Host | Permissão exigida | | ------- | ------------- | ----------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/redemption_requests MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `status` | array de strings | opcional | Um ou mais status do pedido. Repita o parâmetro para enviar mais de um. | | `quotation_date` | string | opcional | Filtra pela data de cotização (`YYYY-MM-DD`). | | `investor_name` | string | opcional | Parte do nome do investidor (sem diferenciar maiúsculas). | | `investor_document_number` | string | opcional | Filtra pelo documento do investidor, no mesmo formato em que foi cadastrado (com pontuação). | | `request_from_datetime` | string (date-time) | opcional | Pedidos com data/hora de solicitação maior ou igual ao valor, no formato `YYYY-MM-DDTHH:MM:SSZ` (UTC). | | `request_to_datetime` | string (date-time) | opcional | Pedidos com data/hora de solicitação menor ou igual ao valor, no formato `YYYY-MM-DDTHH:MM:SSZ` (UTC). | ```text title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/redemption_requests?page=0&limit=50&investor_document_number=969.698.790-03 ``` ## Response STATUS 200 Cada item de `data` é o objeto **Redemption Request** completo, descrito em [Consultar Pedido de Resgate por chave](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request) — lá estão também os [tipos](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request_type) e os [status](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request_status). ```json title="Response Body (resumido)" { "data": [ { "redemption_request_key": "UUID", "redemption_request_type": "number_of_quotas", "status": "quoted", "quotation_date": "2024-06-15", "payment_date": "2024-06-18", "payment_method": "regular", "request_datetime": "2024-06-10T14:00:00Z", "redemption_request_data": { "number_of_quotas": 500.0 }, "processed_value": 5250.5, "ir_value": 0.0, "iof_value": 0.0 } ], "limit": 20, "page": 0, "is_last_page": true } ``` | Campo | Tipo | Descrição | | -------------- | ------- | ---------------------------------- | | `data` | array | Pedidos de resgate | | `limit` | integer | Itens por página | | `page` | integer | Página retornada | | `is_last_page` | boolean | `true` quando não há mais páginas | Um valor de `status` que não existe não gera erro: a consulta apenas não encontra pedidos. ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------ | | 400 | `QIT000001` | Data ou data/hora em formato inválido | | 400 | `QIT000004` | O fundo não é da gestora | | 404 | `QTA000002` | Classe de fundo não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Consulta paginada de pedidos de resgate por investidor URL: /documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor Retorna os **pedidos de resgate** de um investidor identificado por `investor_key`, com paginação e filtros opcionais. A lista é ordenada por fundo, subclasse, série e data de cotização (mais recente primeiro). :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | -------------------------------- | | Gestora | `manager-api` | Leitura | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/investor/{investor_key}/redemption_requests MÉTODO GET Para a gestora, a consulta retorna apenas pedidos em fundos dela, e só de investidores aos quais ela está vinculada. ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `status` | array de strings | opcional | Um ou mais status do pedido. Repita o parâmetro para enviar mais de um. | | `quotation_date` | string | opcional | Filtra pela data de cotização no formato `YYYY-MM-DD`. | | `fund_class_document_number` | string | opcional | Filtra pelo CNPJ da classe de fundo. | | `request_from_datetime` | string (date-time) | opcional | Pedidos com data/hora de solicitação maior ou igual ao valor, no formato `YYYY-MM-DDTHH:MM:SSZ` (UTC). | | `request_to_datetime` | string (date-time) | opcional | Pedidos com data/hora de solicitação menor ou igual ao valor, no formato `YYYY-MM-DDTHH:MM:SSZ` (UTC). | ```text title="Exemplo de chamada" GET /quota/investor/{investor_key}/redemption_requests?page=0&limit=20&status=quoted"ation_date=2024-06-15 ``` ## Response STATUS 200 Cada item de `data` é o objeto **Redemption Request** completo, descrito em [Consultar Pedido de Resgate por chave](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request) — lá estão também os [tipos](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request_type) e os [status](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave#redemption_request_status). ```json title="Response Body (resumido)" { "data": [ { "redemption_request_key": "UUID", "redemption_request_type": "number_of_quotas", "status": "quoted", "quotation_date": "2024-06-15", "payment_date": "2024-06-18", "payment_method": "regular", "request_datetime": "2024-06-10T14:00:00Z", "redemption_request_data": { "number_of_quotas": 500.0 }, "processed_value": 5250.5, "ir_value": 0.0, "iof_value": 0.0 } ], "limit": 20, "page": 0, "is_last_page": true } ``` | Campo | Tipo | Descrição | | -------------- | ------- | ---------------------------------- | | `data` | array | Pedidos de resgate | | `limit` | integer | Itens por página | | `page` | integer | Página retornada | | `is_last_page` | boolean | `true` quando não há mais páginas | Um valor de `status` que não existe não gera erro: a consulta apenas não encontra pedidos. ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------ | | 400 | `QIT000001` | Data ou data/hora em formato inválido | | 400 | `QIT000004` | A gestora não está vinculada ao investidor | | 404 | `QTA000021` | Investidor não encontrado | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Criar Pedido de Resgate URL: /documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate Cria um pedido de resgate de cotas de um investidor em uma série de emissão. Fundos de condomínio fechado não aceitam pedido de resgate. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ----------------------------------- | | Gestora | `manager-api` | Escrita | URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /quota/investor/INVESTOR_KEY/redemption_request MÉTODO POST STATUS 201 ```json title='Request Body' { "issuance_serie_key": "UUID", "redemption_request_type": "gross_redemption_value", "gross_redemption_value": 1000.0, "payment_method": "regular", "disbursement_account_key": "UUID", "quotation_date": "2025-01-15" } ``` :::caution Atenção O campo **redemption_request_type** define qual campo de valor deve ser enviado. Envie **somente** esse campo; mandar um campo de outro tipo devolve `QTA000025`. - `gross_redemption_value`: envie `gross_redemption_value`. - `remaining_application_value`: envie `remaining_application_value`. - `number_of_quotas`: envie `number_of_quotas`. - `net_value_redemption`: envie `net_value`. O campo **disbursement_account_key** indica uma conta específica do investidor para o pagamento. Sem ele, a conta principal do investidor é usada. ::: ### Body params | Campo | Tipo | Descrição | Obrigatório | | ----------------------------- | ------ | ----------------------------------------------------------------------------------------- | ----------- | | `issuance_serie_key` | string | Chave única da série de emissão | Sim | | `redemption_request_type` | string | Enumerador de **[Tipos de Pedido de Resgate](#tipos_de_pedido_de_resgate)** | Sim | | `gross_redemption_value` | float | Valor bruto do resgate, sem descontar IR e IOF | Condicional | | `net_value` | float | Valor líquido do resgate, já descontados IR e IOF | Condicional | | `remaining_application_value` | float | Valor restante da aplicação | Condicional | | `number_of_quotas` | float | Quantidade de cotas a resgatar | Condicional | | `disbursement_account_key` | string | Chave da conta bancária do investidor que receberá o pagamento | Não | | `quotation_date` | string | Data de cotização do resgate (`yyyy-mm-dd`). Precisa ser dia útil e respeitar os prazos da série | Não | | `payment_method` | string | Método de pagamento: `regular` **(default)** ou `b3` | Não | | `reference_date` | string | Data de referência do resgate (`yyyy-mm-dd`) | Não | | `redemption_request_key` | string | Chave (UUID) a usar no pedido, se você quiser defini-la | Não | Campos fora desta lista são recusados com `QIT000001`. ### Tipos de Pedido de Resgate {#tipos_de_pedido_de_resgate} | Enumerador | Descrição | | ----------------------------- | -------------------------------- | | `gross_redemption_value` | Resgate por valor bruto | | `number_of_quotas` | Resgate por número de cotas | | `remaining_application_value` | Resgate por posição remanescente | | `net_value_redemption` | Resgate por valor líquido | ## Response A resposta traz o pedido de resgate criado, no mesmo formato da [consulta por chave](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave). Guarde o `redemption_request_key`. ```json title='Response Body (resumido)' { "redemption_request_key": "UUID", "redemption_request_type": "gross_redemption_value", "status": "pending_quote", "quotation_date": "2025-01-15", "payment_date": "2025-01-16", "payment_method": "regular" } ``` ## Erros | Status | Código | Quando acontece | | ------ | ----------- | --------------------------------------------------------------------------------------------------- | | 400 | `QTA000025` | Falta o campo de valor do tipo escolhido, ou foi enviado o campo de outro tipo | | 400 | `QTA000190` | Resgate por valor líquido de até R$ 10,00 (exceto investidor isento) | | 400 | `QTA000241` | Já existe um pedido de resgate por valor remanescente no mesmo dia | | 400 | `QTA000242` | Valor disponível insuficiente por causa de cotas bloqueadas | | 400 | `QTA000176` | `quotation_date` não é dia útil | | 400 | `QTA000182` | `quotation_date` anterior à data contábil do fundo | | 400 | `QTA000186` | `quotation_date` anterior à data mínima de cotização da série | | 400 | `QTA000296` | Investidor do tipo `nominee` | | 400 | `QIT000004` | A gestora não está vinculada ao investidor | | 404 | `QTA000015` | Série de emissão não encontrada | | 404 | `QTA000021` | Investidor não encontrado | | 404 | `QTA000180` | O fundo é de condomínio fechado e não aceita pedido de resgate | | 404 | `QTA000239` | O patrimônio do investidor não cobre todos os resgates pedidos | | 404 | `QTA000243` | O investidor não tem aplicação resgatável nessa série | | 422 | `QTA000357` | Movimentação bloqueada: a série está com valor de cota zerado ou negativo | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Enviar Termo de Adesão Assinado URL: /documentation/iaas/passivo/termo_de_adesao/enviar_termo_de_adesao_assinado ## Introdução Este recurso tem como objetivo nos enviar a comprovação de assinatura do **termo de adesão** de um **investidor** a uma **série de emissão** de um fundo. :::caution Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Distribuidor**. ::: ### Input / Output: Como ***input*** deve ser enviado o UUID da **série de emissão** do fundo que o investidor aderiu e **tipo de assinatura** e dependendo da assinatura o conteúdo necessário para validação. Segue abaixo exemplo. Como ***output*** será entregue uma ***investor_adhesion_key***. A ***investor_adhesion_key*** é utilizada para identificar a **adesão do investidor**. A adesão é criada já no status `active`. ## Request ENDPOINT /investor_adhesion/investor/INVESTOR_KEY/signed_investor_adhesion MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "issuance_serie_key": "UUID", "signature_method": "opt_in", "opt_in_hash" : "OPT_IN_HASH" } ``` | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------------|--------|---------------------------------------------------------------------------------------------|------------|-------------| | `issuance_serie_key` | string | Chave da série de emissão a qual o investidor aderiu | 36 | Sim | | `signature_method` | string | Método de assinatura usado: `opt_in` ou `external` | até 100 | Sim | | `opt_in_hash` | string | Hash do opt-in. Obrigatório quando `signature_method` é `opt_in` | até 500 | Não | | `document_b64` | string | Termo assinado codificado em base64. Obrigatório quando `signature_method` é `external` | - | Não | | `signer_group_key` | string | Chave do grupo de signatários do investidor. Se omitido, usa o grupo padrão do investidor | 36 | Não | :::caution Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: ## Response ```json title='Response Body' { "investor_adhesion_key": "UUID" } ``` ## Erros | Status | Código | Quando acontece | | ------ | ----------- | --------------------------------------------------------------------------------------- | | 400 | `IAD000027` | A classificação do investidor não permite aderir à série | | 400 | `IAD000037` | `signature_method` é `opt_in` e `opt_in_hash` não foi enviado | | 400 | `IAD000038` | `signature_method` é `external` e `document_b64` não foi enviado | | 400 | `IAD000039` | Já existe uma adesão do investidor para essa série de emissão | | 400 | `IAD000051` | O investidor não possui grupo de signatários (ou o `signer_group_key` não existe) | | 400 | `IAD000054` | O investidor está não operacional | | 400 | `QIT000011` | A integração não é a distribuidora do investidor | | 404 | `IAD000012` | Investidor não encontrado | | 404 | `IAD000018` | Série de emissão não encontrada | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros). --- # Solicitar Termo de Adesão URL: /documentation/iaas/passivo/termo_de_adesao/solicitar_termo_de_adesao ## Introdução Este recurso tem como objetivo criar uma solicitação de **termo de adesão** de um **investidor** a uma **série de emissão** de um fundo. A partir desta solicitação, são gerados os documentos necessários para a formalização da adesão, de acordo com as configurações da série de emissão. ### Input / Output: Como ***input*** deve ser enviado o UUID da **série de emissão** em que o investidor está aderindo e, opcionalmente, o **método de assinatura** que será utilizado para os documentos gerados. Como ***output*** será entregue uma ***investor_adhesion_key***. A ***investor_adhesion_key*** é utilizada para identificar a **adesão do investidor**. :::info Disponível em | Perfil | Host | Permissão exigida | | ----------- | ---------------- | ------------------------------------------------------------- | | Gestora | `manager-api` | Escrita | | Consultoria | `consultant-api` | Criar Adesões | A série de emissão precisa ser de um fundo da gestora (ou, para a consultoria, de um fundo em que ela tenha essa permissão). URL base de cada host: [Ambientes (Hosts)](/documentation/iaas/introducao/inicio#ambientes-hosts). ::: ## Request ENDPOINT /investor_adhesion/investor/INVESTOR_KEY/investor_adhesion MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "issuance_serie_key": "UUID", "signature_method": "qi_sign", "signer_group_key": "UUID" } ``` ### Investor Adhesion | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------------|--------|------------------------------------------------------------------------|------------|-------------| | `issuance_serie_key` | string | Chave da série de emissão a qual o investidor está aderindo | 36 | Sim | | `signature_method` | string | Enumerador do método de assinatura a ser utilizado nos documentos. Se omitido: `qi_sign` para pessoa física e `certifiqi` para pessoa jurídica | - | Não | | `signer_group_key` | string | Chave do grupo de signatários do investidor. Se omitido, usa o grupo de signatários padrão do investidor | 36 | Não | ### Signature Method | Enumerador | Descrição | |---------------|--------------------------------------------------------------| | `certifiqi` | Assinatura via CertifiQi (Certificado Digital) | | `qi_sign` | Assinatura via QI Sign (Assinatura Eletrônica) | ## Response ```json title='Response Body' { "investor_adhesion_key": "UUID" } ``` :::info Fluxo da adesão - Se todos os documentos exigidos pela série já existirem e estiverem vigentes, a adesão é criada direto no status `active`. - Caso contrário, a adesão é criada no status `pending_documents` e permanece assim até que os documentos exigidos sejam gerados e assinados. - Se o investidor já tiver uma adesão `active`, `pending_documents` ou `pending_batch_close` para a mesma série de emissão, a requisição é rejeitada com `IAD000014`. ::: ## Erros | Status | Código | Quando acontece | | ------ | ----------- | ------------------------------------------------------------------------------------------------ | | 400 | `IAD000027` | A classificação do investidor (geral, qualificado, profissional) não permite aderir à série | | 400 | `IAD000042` | O cadastro do investidor está pendente de atualização | | 400 | `IAD000045` | O investidor não possui suitability ativo | | 400 | `IAD000051` | O investidor não possui grupo de signatários (ou o `signer_group_key` informado não existe) | | 400 | `IAD000054` | O investidor está não operacional | | 400 | `QIT000011` | A série de emissão não pertence a um fundo da gestora | | 403 | `IAD000049` | A consultoria não tem a permissão de criar adesões no fundo da série | | 404 | `IAD000012` | Investidor não encontrado (na `manager-api`, hoje a resposta vem como `IAD000010`) | | 404 | `IAD000018` | Série de emissão não encontrada | | 404 | `IAD000040` | `signature_method` não encontrado | | 409 | `IAD000014` | O investidor já tem adesão ativa ou aguardando assinatura para essa série de emissão | | 409 | `IAD000057` | O investidor já possui um vínculo com essa série de emissão | Erros de autenticação, permissão e host: veja [Erros da API](/documentation/iaas/introducao/erros).