Commercial Notes Bookkeeping Integration Guide

The homologation guide describes all the resources and functionalities that need to be tested by the integration partner in QI Tech's sandbox environment (testing environment), before going into production environment for commercial notes issuance.

This guide describes all the resources and functionalities involved in the product.

Attention

All tests must be mandatorily performed in QI Tech's Sandbox environment (testing environment). Operations performed in Sandbox environment are fictional financial operations, serving only for API functionality testing.

Bookkeeping API Registration and Authentication

Code	Step	Description	Documentation Link	Prerequisites
CAB0001*	Public key exchange	Perform public key exchange with the platform operations team (suporte.dcm@qitech.com.br)	Documentation Link
CAB0002*	Call authentication test	After receiving the API key from the platforms team, complete call authentication test	Documentation Link Documentation Link	CAB0001
CAB0003*	Webhook configuration	Configure the URL for QI webhook sending.	Documentation Link Documentation Link Documentation Link	CAB0001 and CAB0002

Issuer Homologation

Attention

For the issuer homologation flow, if the client has already performed the integration with QI TECH assignor registrations, it's possible to reuse these registrations, simplifying the homologation in the bookkeeping system

Issuer homologation for registrations made in the QI TECH assignor system

Code	Step	Description	Documentation Link	Prerequisites
CED1001*	Reuse assignor registration	Reuse assignor registration using their CNPJ.	Documentation Link
CED1002*	List registered issuers	List registered assignors, with filters by CNPJ, name	Documentation Link
CED1003*	Issuer details	View details of a registered issuer, by issuer_key	Documentation Link

Issuer homologation for registrations made through the bookkeeping system

Code	Step	Description	Documentation Link	Prerequisites
CED0001*	Basic issuer registration	Create the issuer, providing basic registration information.	Documentation Link
CED0002*	Issuer document sending and removal	Sending and removal of documents associated with a previously registered issuer	Documentation Link Documentation Link	CED0001
CED0003*	Issuer representatives registration and removal	Sending and removal of representatives associated with a previously registered issuer	Documentation Link Documentation Link	CED0001
CED0004*	Issuer representative documents sending and removal	sending and removal of documents associated with a representative of a previously registered issuer	Documentation Link Documentation Link	CED0001, CED0003
CED0005*	Issuer bank account registration and removal	registration and removal of bank account associated with a previously registered issuer	Documentation Link Documentation Link	CED0001
CED0006*	Issuer signatory groups registration and removal	registration and removal of signatory groups associated with a previously registered issuer	Documentation Link Documentation Link	CED0001
CED0007*	Issuer contact information registration and removal	registration and removal of contact information associated with a previously registered issuer	Documentation Link Documentation Link	CED0001
CED0008*	Send issuer for analysis	This endpoint allows changing an issuer's status to under analysis, sending it to the validation process.	Documentation Link	CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007
CED0009*	Issuer registration modification	modify issuer to allow editing	Documentation Link	CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007
CED0010*	List registered issuers	List registered assignors, with filters by CNPJ, name	Documentation Link
CED0011*	Issuer details	View details of a registered issuer, by issuer_key	Documentation Link

Investor Homologation

Attention

For the investor homologation flow, if the client has fixed funds, it's possible to register these in the setup, simplifying the integration.

Investor homologation for registrations made in setup

Code	Step	Description	Documentation Link	Prerequisites
INV1001*	List registered investors	List registered funds, with filters by CNPJ, name	Documentation Link
INV1002*	Investor details	View details of a registered investor, by investor_key	Documentation Link

Investor homologation for registrations made through the bookkeeping system

Code	Step	Description	Documentation Link	Prerequisites
INV0001*	Basic investor registration	Create the investor, providing basic registration information.	Documentation Link
INV0002*	Investor document sending and removal	Sending and removal of documents associated with a previously registered investor	Documentation Link Documentation Link	INV0001
INV0003*	Investor representatives registration and removal	Sending and removal of representatives associated with a previously registered investor	Documentation Link Documentation Link	INV0001
INV0004*	Investor representative documents sending and removal	sending and removal of documents associated with a representative of a previously registered investor	Documentation Link Documentation Link	INV0001, INV0003
INV0005*	Investor bank account registration and removal	registration and removal of bank account associated with a previously registered investor	Documentation Link Documentation Link	INV0001
INV0006*	Investor signatory groups registration and removal	registration and removal of signatory groups associated with a previously registered investor	Documentation Link Documentation Link	INV0001
INV0007*	Investor contact information registration and removal	registration and removal of contact information associated with a previously registered investor	Documentation Link Documentation Link	INV0001
INV0008*	Send investor for analysis	This endpoint allows changing an investor's status to under analysis, sending it to the validation process.	Documentation Link	INV0001, INV0002, INV0003, INV0004, INV0005, INV0006, INV0007
INV0009*	Investor registration modification	modify investor to allow editing	Documentation Link	INV0001, INV0002, INV0003, INV0004, INV0005, INV0006, INV0007
INV0010*	List registered investors	List registered funds, with filters by CNPJ, name	Documentation Link
INV0011*	Investor details	View details of a registered investor, by investor_key	Documentation Link

Commercial note issuance

After issuer and investor registrations, it's possible to issue commercial notes. For this, there are some combinations of issuance flows, which will be covered below.

Code	Step	Description	Documentation Link	Prerequisites
COM0001*	Financial conditions simulation	simulate the financial conditions and payment flow of an operation	Documentation Link
COM0002*	Commercial note operation registration	create a new commercial note operation based on financial and investor data.	Documentation Link	COM0001
COM0003*	Related parties registration and removal	registration and removal of related parties to an operation	Documentation Link	COM0002
COM0004*	Related party representative documents sending and removal	sending and removal of documents associated with representatives of related parties to an operation	Documentation Link	COM0002, COM0003
COM0005*	Related party representative signatory groups sending and removal	sending and removal of signatory groups associated with representatives of related parties to an operation	Documentation Link	COM0002, COM0003
COM0006	Preview constitutive term	generation of a draft Constitutive Term for a specific operation, using a predefined template.	Documentation Link	COM0002
COM0007*	Modify constitutive term template	modification of the Constitutive Term template for a specific operation	Documentation Link	COM0002
COM0008*	Document upload	upload documents associated with an operation. The returned "document_key" can be used, for example, in the guarantees system	Documentation Link	COM0002
COM0009*	Operation guarantee submission	addition of guarantees associated with an operation	Documentation Link	COM0002, COM0008
COM0010*	Contract/Guarantee related parties registration and removal	registration and removal of related parties for a specific contract/guarantee of the operation	Documentation Link	COM0002, COM0003
COM0011*	Send operation for analysis	change an operation's status to "under analysis", sending it to the compliance validation process by the bookkeeper	Documentation Link	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0012*	Send signed approval minutes	This endpoint allows sending externally signed approval minutes from SA or COP type companies to the bookkeeping system, sending a base64 that will be analyzed and approved by the bookkeeper.	Documentation Link	COM0002
COM0013*	Query operations by filters	query commercial note operations using optional filters	Documentation Link	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0014*	Query operation by key	query complete details of a specific operation, using its unique key.	Documentation Link	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009

In case signature is via QI SIGN

Code	Step	Description	Documentation Link	Prerequisites
COM0015*	Query operation signature links via QI SIGN	query all signature links for a specific operation via QI SIGN, using its unique key.	Documentation Link	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009
COM0016*	Query signed contract links via QI SIGN for operation	query all signed documents of a specific operation via QI SIGN, using its unique key	Documentation Link	COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009

Integration/Subscription process

Code	Step	Description	Documentation Link	Prerequisites
INT0001*	Query integration by key	query the details of an integration process using its unique key	Documentation Link
INT0002*	Subscription query	query an ongoing subscription	Documentation Link	INT0001
INT0003	Subscription registration	register an investor's intention to subscribe a specific quantity of integration quotas (useful when it's necessary to reschedule a subscription date)	Documentation Link	INT0001, INT0002
INT0004	Cancel subscription	cancel subscription (useful when it's necessary to reschedule a subscription date)	Documentation Link	INT0001, INT0002

Error mapping

Errors originating from issuer, investor and commercial note APIs can be found at Error Catalog Link