This connector uses the Qive API with an API key and an API permission key, sent as the
x-api-key and x-api-permission-key headers. Generate both in the Qive platform under your integration/API settings — the permission key defines which companies and documents the API key can access.1. Add your Qive access
- In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Qive option from the list of connectors.
-
Click Next and you’ll be prompted to fill the configuration.
- API Key: Your Qive API key.
- API Permission Key: Your Qive API permission key.
- Start Date (advanced): The earliest document creation date (in the Qive platform) to sync. Defaults to full history.
- Click Next.
2. Select your Qive streams
-
The next step is letting us know which streams you want to bring. You can select entire groups of streams or only a subset of them.
Tip: The stream can be found more easily by typing its name.
- Click Next.
3. Configure your Qive data streams
-
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
- Click Next.
4. Configure your Qive data source
- Describe your data source for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
- To define your Trigger, consider how often you want data to be extracted from this source.
- Optionally, you can define some additional settings (if available).
Check your new source!
- Click Next to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
- You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. If needed, manually trigger the pipeline by clicking on the refresh icon.
If you encounter any issues, reach out to us, and we’ll gladly assist you!
Streams and Fields
Below you’ll find all available data streams from Qive.NF-e
NF-e
Electronic invoices (NF-e) of the account, with document data, XML, events, and manifestations. Synced incrementally on the date the document was created in the Qive platform.Fields:
AccessKey:String- 44-digit access key that uniquely identifies the NF-eNumber:String- Sequential number of the NF-eStatus:String- Current status of the NF-e (authorized, canceled)Origin:String- How the NF-e entered the Qive platform (sefaz, upload, email, integracoes, and others)FlagErp:Boolean- Whether the NF-e has been flagged as posted in the ERPHasCCE:Boolean- Whether the NF-e has an electronic correction letter (CC-e)CreatedAt:DateTime- Date and time the NF-e record was created in the Qive platform, used as the incremental replication keyEmissionDate:DateTime- Date and time the NF-e was issuedOwner:String- CNPJ/CPF of the company that owns the document in QiveOwnerRole:String- Role of the owner in the NF-e (received, emitted, transporter, authorized)Tags:Array of Strings- Tags associated with the NF-e in QiveCfops:Array of Strings- CFOP codes (fiscal operation codes) present in the NF-e itemsXml:String- Full NF-e XML, base64 encodedDocument:String- Full NF-e document converted to JSON, serialized as a JSON stringEmitter:String- Issuer of the NF-e (CNPJ/CPF, name, trading name, state registration, address state), serialized as a JSON stringReceiver:String- Recipient of the NF-e (CNPJ/CPF, name, trading name, state registration, address state), serialized as a JSON stringEvents:String- Events registered for the NF-e, each with type and XML, serialized as a JSON stringManifestations:String- Recipient manifestations registered for the NF-e, serialized as a JSON string
NF-e Events
NF-e Events
Events of each NF-e (cancellations, correction letters, and others), fetched per access key for the NF-es synced in the current run.Fields:
event_id:String- Deterministic identifier of the event, derived from the access key, event type, and XML payloadaccess_key:String- 44-digit access key of the NF-e the event belongs totype:String- 6-digit event type code (for example, 110111 for NF-e cancellation, 110110 for correction letter)xml:String- Event XML, base64 encoded
CT-e
CT-e
Electronic transport documents (CT-e) of the account, with document data, XML, events, and all involved parties. Synced incrementally on the date the document was created in the Qive platform.Fields:
AccessKey:String- 44-digit access key that uniquely identifies the CT-eNumber:String- Sequential number of the CT-eStatus:String- Current status of the CT-e (authorized, canceled)Origin:String- How the CT-e entered the Qive platform (sefaz, upload)FlagErp:Boolean- Whether the CT-e has been flagged as posted in the ERPHasCCE:Boolean- Whether the CT-e has an electronic correction letter (CC-e)CreatedAt:DateTime- Date and time the CT-e record was created in the Qive platform, used as the incremental replication keyEmissionDate:DateTime- Date and time the CT-e was issuedOwner:String- CNPJ/CPF of the company that owns the document in QiveOwnerRole:Array of Strings- Roles of the owner in the CT-e (received, emitted, taker)Tags:Array of Strings- Tags associated with the CT-e in QiveCfops:Array of Strings- CFOP codes (fiscal operation codes) present in the CT-eAccessKeyPrev:Array of Strings- Access keys of previous documents linked to the CT-eAccessKeysComp:Array of Strings- Access keys of complementary documents linked to the CT-eXml:String- Full CT-e XML, base64 encodedDocument:String- Full CT-e document converted to JSON, serialized as a JSON stringEmitter:String- Issuer of the CT-e (CNPJ/CPF, name, trading name, state registration, contact email, address), serialized as a JSON stringReceiver:String- Receiver of the cargo, serialized as a JSON stringSender:String- Sender of the cargo, serialized as a JSON stringDispatcher:String- Dispatcher of the cargo, serialized as a JSON stringAddressee:String- Addressee of the cargo, serialized as a JSON stringTaker:String- Service taker of the CT-e, serialized as a JSON stringIBSCBS:String- IBS/CBS tax information of the CT-e, when present, serialized as a JSON stringEvents:String- Events registered for the CT-e, each with type and XML, serialized as a JSON stringManifestations:String- Manifestations registered for the CT-e, serialized as a JSON string
CT-e Events
CT-e Events
All CT-e events of the account (cancellations, correction letters, and others). Synced as full table on every run.Fields:
event_id:String- Deterministic identifier of the event, derived from the access key, event type, and XML payloadaccess_key:String- 44-digit access key of the CT-e the event belongs totype:String- 6-digit event type code (for example, 110111 for CT-e cancellation, 110110 for correction letter)xml:String- Event XML, base64 encoded