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.
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
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 the assignor registration using its CNPJ. | Documentation Link | |
| CED1002* | List of registered issuers | List of registered assignors, with filters by CNPJ, name | Documentation Link | |
| CED1003* | Issuer details | View the details of a registered issuer, by issuer_key | Documentation Link |
Investor Homologation
For the investor homologation flow, if the client has fixed funds, it's possible to register them during setup, simplifying the integration.
Investor homologation for registrations made during setup
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| INV1001* | List of registered investors | List of registered funds, with filters by CNPJ, name | Documentation Link | |
| INV1002* | Investor details | View the details of a registered investor, by investor_key | Documentation Link |
Commercial note issuance
After the issuer and investor registrations, commercial notes can be issued. For this, there are some combinations of issuance flows, which are covered below.
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| COM0001 | Simulation of financial conditions | simulate the financial conditions and the payment flow of an operation | Documentation Link | |
| COM0002* | Commercial Note Operation Registration | create a new commercial note operation based on the financial and investor data. | Documentation Link | COM0001 |
| COM003* | Submit Operation for Analysis | change the status of an operation to "under analysis", sending it to the compliance validation process by the bookkeeper | Documentation Link | COM0002 |
| COM004* | Submit Signed Contracts | This endpoint allows sending externally signed contracts to the bookkeeping system, sending a base64 that will be analysed and approved by the bookkeeper. | Documentation Link | COM0002 |
| COM0005 | Query Operations by Filters | query commercial note operations using optional filters | Documentation Link | COM0002, COM0003, COM0004 |
| COM0006 | Query Operation by Key | query the complete details of a specific operation, using its unique key. | Documentation Link | COM0002, COM0003, COM0004 |
Error mapping
Errors originating from the issuer, investor and commercial note APIs can be found in Error Catalog Link