Qive

8 min

Objetivo

O conector da Qive é uma solução voltada para a automação da consulta e gestão de documentos fiscais eletrônicos, como NF-e, NFSe, CTe e dados de CNPJ.

Com este conector, é possível integrar sistemas internos (como ERPs ou plataformas financeiras) para buscar, consultar e processar documentos fiscais automaticamente, reduzindo a necessidade de consultas manuais e garantindo maior confiabilidade dos dados.

O objetivo principal é fornecer uma integração direta com a API da Qive, permitindo o consumo estruturado de informações fiscais para uso em processos financeiros, contábeis e operacionais.:

Criando um fluxo utilizando o conector Qive

Para criar um fluxo utilizando o conector da Qive, é necessário estabelecer uma conexão válida e, em seguida, configurar os recursos desejados no canvas.

Criando conexão Qive

A Qive utiliza credenciais baseadas em chaves de API para garantir a segurança dos dados. Para realizar a integração, você deve gerar suas credenciais diretamente no painel da sua conta Qive.

Configuração na Qive

Acesse o seu painel da Qive.

Navegue até a seção de integrações ou configurações de API.

Gere ou obtenha o seu API-ID (ID da API) e API-KEY (Chave da API).

Configuração na Fluid

Ao criar a conexão na Fluid, você deverá preencher os seguintes parâmetros de autenticação e ambiente:

Ambiente: Selecione o ambiente desejado para a conexão. As opções disponíveis são Produção ou SandBox (campo obrigatório);

API-ID: O identificador da sua aplicação fornecido pela Qive (campo obrigatório);

API-KEY: A chave secreta correspondente para autorizar as requisições (campo obrigatório).

OBS: Criar Conexão e acesse nosso passo a passo para saber como criar uma conexão.

Configurando fluxo Qive

Crie um fluxo e arraste o conector Qive para o canvas.

OBS: Criar Fluxo e acesse nosso passo a passo para saber como criar um fluxo.

Selecione o conector e na aba de Parametrização preencha os seguintes parâmetros de configuração:

Recurso: Domínio da API da Qive que será utilizado (NFe, NFSe, CTe, CNPJ, Etiquetas ou Boletos).

Operação: Ação específica que será executada para o recurso selecionado.

Operações disponíveis por Recurso:

1. NFe (Nota Fiscal Eletrônica)

Buscar NFE Recebidas: Retorna os XMLs das notas recebidas. Permite filtrar por cursor, custom properties (Query Language), chaves de acesso, CNPJs e período de criação. Limite máximo de 50 documentos.

Buscar NFE Emitidas: Retorna os XMLs das notas emitidas. Permite os mesmos filtros da busca de recebidas.

Buscar NFE Manifestadas: Busca notas específicas utilizando uma lista de chaves de acesso.

Manifestar NFE: Realiza a manifestação do destinatário (ex: Ciência da Operação, Confirmação) enviando um corpo na requisição.

Manifestar NFE (Síncrono): Realiza a manifestação do destinatário de forma síncrona, retornando o resultado do processamento na mesma requisição. Utiliza os mesmos códigos de manifestação da operação assíncrona (ex: 210200 – Confirmação, 210210 – Ciência, 210220 – Desconhecimento, 210240 – Não Realizada, que exige justificativa).

Atualizar Propriedade de NFe: Atualiza uma custom property de uma NFe já processada. Permite selecionar o papel do documento (Recebida, Emitida, Transportadora ou Autorizada) e o nome da propriedade a ser atualizada, enviando o novo valor no corpo da requisição.

2. NFSe (Nota Fiscal de Serviços Eletrônica)

Buscar NFSe Recebidas: Retorna as notas de serviço recebidas. Permite filtrar por cursor, IDs, CNPJs e período de criação.

Buscar NFSe Emitidas: Retorna as notas de serviço emitidas. Permite os mesmos filtros da busca de recebidas.

Atualizar Propriedade de NFSe Recebida: Atualiza uma custom property de uma NFSe. Permite selecionar o papel do documento (Recebida ou Emitida) e o nome da propriedade a ser atualizada, enviando um array com os IDs das notas e os respectivos valores no corpo da requisição.

3. CTe (Conhecimento de Transporte Eletrônico)

Buscar CTE (Tomador): Retorna os CT-es onde sua empresa é o tomador do serviço. Permite filtrar por cursor, chaves de acesso, CNPJs e período de criação.

Buscar CTE (Não Tomador): Retorna os CT-es vinculados ao seu CNPJ onde a empresa não é a tomadora. Permite escolher o formato de retorno (XML ou JSON) e aplicar filtros de cursor, chaves e datas.

Atualizar Propriedade de CTe: Atualiza uma custom property de um CT-e. Permite selecionar o papel do documento (Tomador ou Não Tomador) e o nome da propriedade a ser atualizada, enviando um array com as chaves de acesso e os respectivos valores no corpo da requisição.

4. CNPJ

Buscar múltiplos CNPJs: Realiza a consulta em lote enviando uma lista de CNPJs.

Buscar CNPJ único: Consulta detalhada dos dados de um único CNPJ.

5. Etiquetas

Lista Etiquetas da Conta: Retorna as etiquetas cadastradas na conta Qive. Permite filtrar pelo tipo de etiqueta (comum ou pertencente ao fluxo "NFe em Etapas"), por termo de busca no nome e por uma lista de IDs específicos.

6. Boletos

Buscar Boletos com Notas: Retorna os boletos emitidos contra um CNPJ/CPF (sacado), já vinculados às notas fiscais correspondentes. Permite filtrar por datas de atualização, emissão e vencimento, identificador do documento, status, nível de confiança e tipo de documento vinculado, com paginação por página.

Na prática

Neste tópico, criaremos um exemplo de fluxo para consultar uma NF-e recebida específica utilizando a sua chave de acesso e definindo um limite de busca.

Passo 'getnfe'

Configuração da Parametrização:

Recurso: NFe

Operação: Buscar NFE Recebidas

Limite: 5

Chaves de Acesso (access_key[]): 73231179566794000105550030000849670577498186

Para tratar os dados recebidos (como extrair as informações do XML codificado em base64), utilize o De/para nos passos seguintes.

Conclusão

Com o passo configurado, ao disparar o fluxo, o conector fará a requisição GET https://sandbox-api.arquivei.com.br/v1/nfe/received?limit=5&access_key[]=73231179566794000105550030000849670577498186 e retornará um objeto detalhado contendo a nota e informações de paginação:

{
    "count": 1,
    "data": [
        {
            "access_key": "73231179566794000105550030000849670577498186",
            "xml": "PG5mZVByb2MgeG1sbnM9Imh0dHA6Ly93d3cucG9ydGFsZmlzY2FsLmluZi5ici9uZmUiIHZlcnNhbz0iNC4wMCI..."
        }
    ],
    "page": {
        "next": "https://sandbox-api.arquivei.com.br/v1/nfe/received?access_key[0]=73231179566794000105550030000849670577498186\u0026limit=5\u0026cursor=5",
        "previous": "https://sandbox-api.arquivei.com.br/v1/nfe/received?access_key[0]=73231179566794000105550030000849670577498186\u0026limit=5\u0026cursor=0"
    },
    "signature": "bb901068ef682d0a7540eca827adbcecde4c60e8da78def2369af2ed724bbb34",
    "status": {
        "code": 200,
        "message": "Ok"
    }
}