Roteiro de Integração de escrituração de notas comerciais

O roteiro de homologação descreve todos os recursos e funcionalidades que precisam ser testados pelo parceiro integrador no ambiente de sandbox da QI Tech (ambiente de testes), antes da entrada em ambiente de produção para emissão de notas comerciais.

Este roteiro descreve todos os recursos e funcionalidades envolvidos no produto.

Atenção

Todos os testes devem ser obrigatoriamente realizados no ambiente de Sandbox da QI Tech (ambiente de testes). As operações realizadas em ambiente de Sandbox são operações financeiras fictícias, servindo apenas para teste de funcionalidade das APIs.

Cadastro e Autenticação API Escrituração

Código	Etapa	Descrição	Link Documentação	Pré-requisito
CAB0001*	Troca de chaves públicas	Realizar a troca de chaves públicas com o time operações de plataforma (operacao-dcm@qitech.com.br)	Link Documentação
CAB0002*	Teste de autenticação de chamadas	Após receber a chave de api com o time de plataformas, finalizar teste de autenticação de chamadas	Link Documentação Link Documentação	CAB0001
CAB0003*	Configuração de webhooks	Realizar a configuração da url para envio dos webhooks por parte da QI.	Link Documentação Link Documentação Link Documentação	CAB0001 e CAB0002

Homologação do Emissor

Atenção

Para o fluxo de homologação do emissor, caso o cliente já tenha realizado a integração com o cadastros de cedentes QI TECH, é possível reutilizar esses cadastros, simplificando a homologação no sistema de escrituração

Homologação do emissor para cadastros feitos no sistema de cedentes QI TECH

Código	Etapa	Descrição	Link Documentação	Pré-requisito
CED1001*	Reaproveitar cadastro cedente	Realizar o reaproveitamento do cadastro de cedente utilizando o CNPJ do mesmo.	Link Documentação
CED1002*	Listagem dos emissores cadastrados	Listagem dos cedentes cadastrados, com filtros por CNPJ, nome	Link Documentação
CED1003*	Detalhes do emissor	Visualizar os detalhes de um emissor cadastrado, por issuer_key	Link Documentação

Homologação do emissor para cadastros feitos pelo sistema de escrituração

Código	Etapa	Descrição	Link Documentação	Pré-requisito
CED0001*	Cadastro Básico do emissor	Criar o emissor, informando as informações básicas do cadastro.	Link Documentação
CED0002*	Envio e remoção de Documentos do Emissor	Envio e remoção de documentos associados a um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001
CED0003*	Cadastro e remoção de Representantes do Emissor	Envio e remoção de representantes associados a um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001
CED0004*	Envio e remoção de Documentos do Representante do Emissor	envio e remoção de documentos associados a um representante de um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001, CED0003
CED0005*	Cadastro e remoção de Conta Bancária do Emissor	cadastro e remoção de conta bancária associada a um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001
CED0006*	Cadastro e remoção de Grupos de Assinantes do Emissor	cadastro e remoção de grupos de assinantes associados a um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001
CED0007*	Cadastro e remoção de Informações de Contato do Emissor	cadastro e remoção de informações de contato associadas a um emissor previamente cadastrado	Link Documentação Link Documentação	CED0001
CED0008*	Envio para Análise do Emissor	Este endpoint permite alterar o status de um emissor para análise, enviando-o para o processo de validação.	Link Documentação	CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007
CED0009*	Alteração de Cadastro do Emissor	alterar emissor para permitir edição	Link Documentação	CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007
CED0010*	Listagem dos emissores cadastrados	Listagem dos cedentes cadastrados, com filtros por CNPJ, nome	Link Documentação
CED0011*	Detalhes do emissor	Visualizar os detalhes de um emissor cadastrado, por issuer_key	Link Documentação

Homologação do Investidor

Atenção

Para o fluxo de homologação do investidor, caso o cliente tenha fundos fixos, é possível realizar o cadastro desses no setup, simplificando a integração.

Homologação do investidor para cadastros feitos no setup

Código	Etapa	Descrição	Link Documentação	Pré-requisito
INV1001*	Listagem dos investidores cadastrados	Listagem dos fundos cadastrados, com filtros por CNPJ, nome	Link Documentação
INV1002*	Detalhes do investidor	Visualizar os detalhes de um investidor cadastro, por investor_key	Link Documentação

Homologação do investidor para cadastros feitos pelo sistema de escrituração

Código	Etapa	Descrição	Link Documentação	Pré-requisito
INV0001*	Cadastro Básico do investidor	Criar o investidor, informando as informações básicas do cadastro.	Link Documentação
INV0002*	Envio e remoção de Documentos do investidor	Envio e remoção de documentos associados a um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001
INV0003*	Cadastro e remoção de Representantes do investidor	Envio e remoção de representantes associados a um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001
INV0004*	Envio e remoção de Documentos do Representante do investidor	envio e remoção de documentos associados a um representante de um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001, INV0003
INV0005*	Cadastro e remoção de Conta Bancária do investidor	cadastro e remoção de conta bancária associada a um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001
INV0006*	Cadastro e remoção de Grupos de Assinantes do investidor	cadastro e remoção de grupos de assinantes associados a um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001
INV0007*	Cadastro e remoção de Informações de Contato do investidor	cadastro e remoção de informações de contato associadas a um investidor previamente cadastrado	Link Documentação Link Documentação	INV0001
INV0008*	Envio para Análise do investidor	Este endpoint permite alterar o status de um investidor para análise, enviando-o para o processo de validação.	Link Documentação	INV0001, INV0002, INV0003, INV0004, INV0005, INV0006, INV0007
INV0009*	Alteração de Cadastro do investidor	alterar investidor para permitir edição	Link Documentação	INV0001, INV0002, INV0003, INV0004, INV0005, INV0006, INV0007
INV0010*	Listagem dos investidores cadastrados	Listagem dos fundos cadastrados, com filtros por CNPJ, nome	Link Documentação
INV0011*	Detalhes do investidor	Visualizar os detalhes de um investidor cadastrado, por investor_key	Link Documentação

Emissão de nota comercial

Após os cadastros de emissores e investidores, é possível realizar a emissão de notas comerciais. Para isso, existem algumas combinações de fluxos de emissão, que serão contempladas abaixo.

Código	Etapa	Descrição	Link Documentação	Pré-requisito
COM0001*	Simulação de condições financeiras	simular as condições financeiras e o fluxo de pagamentos de uma operação	Link Documentação
COM0002*	Cadastro de Operação de Nota Comercial	criar uma nova operação de nota comercial com base nos dados financeiros e de investidores.	Link Documentação	COM0001
COM0003*	Cadastro e Remoção de Partes Relacionadas	cadastro e a remoção de partes relacionadas a uma operação	Link Documentação	COM0002
COM0004*	Envio e Remoção de Documentos de Representantes de Partes Relacionadas	envio e a remoção de documentos associados a representantes de partes relacionadas a uma operação	Link Documentação	COM0002, COM0003
COM0005*	Envio e Remoção de Grupos de Assinantes de Representantes de Partes Relacionadas	envio e a remoção de grupos de assinantes associados a representantes de partes relacionadas a uma operação	Link Documentação	COM0002, COM0003
COM0006*	Cadastro e Remoção de Partes Relacionadas de um documento específico	cadastro e a remoção de partes relacionadas a uma operação de um documento específico da operação	Link Documentação	COM0002, COM0003
COM0007*	Envio de Garantia na Operação	adição de garantias associadas a uma operação	Link Documentação	COM0002, COM0008
COM0008*	Envio de documentos	envio de documentos associados a uma operação. Tais documentos podem ser utilizados no sistema de garantias para realizar a adição de documentos acessórios, além do instrumento da garantia em si.	Link Documentação	COM0002
COM0009	Pré-visualizar Termo Constitutivo	geração de uma minuta do Termo Constitutivo para uma operação específica, utilizando um template predefinido.	Link Documentação	COM0002
COM0010*	Alterar Template do Termo Constitutivo	alteração do template do Termo Constitutivo para uma operação específica	Link Documentação	COM0002
COM0011*	Enviar Operação para Análise	alterar o status de uma operação para "em análise", enviando-a para o processo de validação de compliance pelo escriturador	Link Documentação	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0012*	Enviar Atas de Aprovação Assinadas	Este endpoint permite enviar as atas de aprovação de empresas do tipo SA ou COP assinadas de forma externa para o sistema de escrituação, enviando um base64 que será analisado e aprovado pelo escriturador.	Link Documentação	COM0002
COM0013*	Consulta de Operações por Filtros	consultar operações de nota comercial utilizando filtros opcionais	Link Documentação	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0014*	Consulta de Operação por Chave	consultar os detalhes completos de uma operação específica, utilizando sua chave única.	Link Documentação	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009

Caso assinatura seja via QI SIGN

Código	Etapa	Descrição	Link Documentação	Pré-requisito
COM0015*	Consulta dos Links para assinatura via QI SIGN da Operação	consultar todos os links para assinatura de uma operação específica via QI SIGN, utilizando sua chave única.	Link Documentação	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0016*	Consulta do Link dos contratos assinados via QI SIGN da Operação	consultar todos os documentos assinados de uma operação específica via QI SIGN, utilizando sua chave única	Link Documentação	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009

Processo de integralização

Código	Etapa	Descrição	Link Documentação	Pré-requisito
INT0001*	Consulta de Integralização por Chave	consultar os detalhes de um processo de integralização utilizando sua chave única	Link Documentação
INT0002*	Consulta de Subscrição	consultar uma subcrição em andamento	Link Documentação	INT0001
INT0003	Cadastro de Subscrição	registrar a intenção de um investidor em subscrever uma quantidade específica de cotas de uma integralização (útil caso seja necessário deslocar a data de uma subscrição)	Link Documentação	INT0001, INT0002
INT0004	Cancelar subscrição	cancelar subscrição (útil caso seja necessário deslocar a data de uma subscrição)	Link Documentação	INT0001, INT0002

Mapeamento de erros

Os erros originários das apis de emissores, investidores e nota comercial podem ser encontrados em Link Catálogo de Erros