Qive
Acesse e gerencie documentos fiscais eletrônicos (NFe, NFSe, CTe, NFCe) com a API da Qive (Arquivei).
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 67 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_v2_dfe_nfe | Este endpoint permite buscar todas as NFes da conta, retornando os dados conforme a projeção solicitada, além de permitir novos filtros como chave de acesso, CNPJ do emitente, transportador e destinatário, status da NFe, entre outros. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . Fields (array) . Filters (object) . Limit (integer) . Paginator (string) } (object) required |
| post_v1_dfe_cte | A API busca CTes através de filtros, retornando os dados dos documentos filtrados. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . fields (array) . Filters (object) . Limit (integer) . Paginator (string) } (object) required |
| post_v1_dfe_nfse | Este endpoint permite buscar todas as NFses da conta, retornando os dados das NFSes obtidas. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . filters (object) . fields (array) . paginator (string) } (object) required |
| post_v1_dfe_upload | Neste endpoint é possível fazer o envio de qualquer Documento Fiscal Eletrônico, assim como seus eventos, em formato XML. DFes Suportados: CFe, CTe, CTeOS, NFCe, NFe, NFSe, NF3e, NFAg, NFGas, NFCom e eventos. A resposta retornada em caso de falha irá indicar qual o problema encontrado no XML enviado. | data: { . xml (string) . owner (array) } (object) required |
| post_v1_dfe_flagerp | Essa API recebe os metadados enviados através de uma chave e valor 'key': 'value', o tipo de documento NFE, NFSE, CTE, CTEOS, CFESAT e NFCE e o id da nota. | X-Use-ApiGateway (string) required data: { . doc_type (string) . id (string) . metadata (array) . owner (string) } (object) required |
| get_v1_nfe_by_role | Este endpoint é responsável por buscar XMLs de NFEs recebidas, utilizando alguns filtros. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campos created_atfrom e created_atto definem um range de b | role (string) required limit (integer) cursor (integer) access_key (array) cnpj (array) filter (string) created_atfrom (string) created_atto (string) format_type (string) |
| put_v1_nfe_by_role_by_property | Através deste endpoint é possível adicionar ou atualizar o valor de uma Property customizada para um determinado documento. A property funciona como um par chave-valor para um documento, permitindo que o usuário indique um valor qualquer para a property que deseja. Por padrão sua conta já possui uma property com chave 'status', sendo possível atribuir valores para esta propery para cada documento. Estes valores podem depois ser utilizados no parâmetro 'filter' do endpoint de GET. | role (string) required property (string) required data: { . data } (object) required |
| post_v1_nfe_upload | Este endpoint é responsável por fazer o upload de um lote de XMLS de NFes. O processo é feito de forma assíncrona, tendo como retorno um request_id que deve ser utilizado no endpoint /v1/nfe/upload/status para acompanhar o status do lote. Pode ser passado uma url de callback no banco callback_url. Caso seja feito, será realizado um callback com o resultado do processamento. | data: { . invoices (array) . callback_url (string) } (object) required |
| get_v1_nfe_upload_status | Este endpoint é responsável por retornar os status do upload de um lote de NFes. Deve ser utilizado o request_id retornado no endpoint /v1/nfe/upload para verificação. Exemplo: GET /nfe/upload/status?request_id=string | request_id (string) |
| get_v2_nfe_manifest | Este endpoint é responsável por buscar a manifestação mais recente realizada em uma NFe. Esta manifestação só ficará disponível caso tenha sido realizada através da plataforma Qive ou da API. | access_key (array) required origin (string) |
| get_v1_nfe_manifest | Este endpoint é responsável por buscar a manifestação mais recente realizada em uma NFe. Esta manifestação só ficará disponível caso tenha sido realizada através da plataforma Qive ou da API. | access_key (array) required |
| post_v1_nfe_manifest | Este endpoint é responsável por realizar a manifestação de uma lista de NFes. O endpoint retorna um request_id que deve ser utilizado para verificar o status da manifestação. Lista de códigos para manifestação: Confirmação: 210200 Ciencia: 210210 Desconhecimento: 210220 Não Realizada: 210240 Mais informações sobre o processo de manifestação do destinatário pode ser encontrado no site da Secretaria da Fazenda: nfe.fazenda.gov.br'http://www.nfe.fazenda.gov.br/portal/exibir | data: { . manifests (array) } (object) required |
| get_v1_nfe_manifest_status | Este endpoint é responsável por retornar os status das manifestações requisitadas através do endpoint anteriormente mencionado. Deve ser utilizado o request_id retornado anteriormente ou uma chave de acesso. | access_key (array) request_id (array) |
| post_v1_nfe_manifest_sync | Este endpoint é responsável por realizar a manifestação de uma NFes. O endpoint retorna a resposta direto da SEFAZ com o status da manifestação. Lista de códigos para manifestação: Confirmação: 210200 Ciencia: 210210 Desconhecimento: 210220 Não Realizada: 210240 Mais informações sobre o processo de manifestação do destinatário pode ser encontrado no site da Secretaria da Fazenda: nfe.fazenda.gov.br'http://www.nfe.fazenda.gov.br/portal/exibirArquivo.aspx?conteudo=bUBJ/Pmt | data: { . manifests (array) } (object) required |
| get_v2_nfe_events | Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos de uma NFe, retornados em base64. Todos os Eventos de uma NFe disponibilizados pela SEFAZ são retornados, sendo possível buscar apenas uma chave de acesso por vez. | access_key (string) required type (array) |
| get_v1_events_nfe | Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos NFe da conta autenticada, retornados em base64. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campo 'type' repres | access_key (array) type (array) limit (integer) cursor (integer) |
| get_v1_nfe_danfe | Este endpoint é responsável por realizar a busca do Documento Auxiliar DANFe de uma NFe, retornando um PDF em base64, | access_key (string) required |
| get_v1_nfse_by_role | Este endpoint é responsável por buscar XMLs de NFSes Nota Fiscal de Serviço recebidas, utilizando alguns filtros. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campos created_atfrom e created_at | role (string) required limit (integer) cursor (integer) id (array) cnpj (array) filter (string) created_atfrom (string) created_atto (string) format_type (string) xml_format (string) |
| get_v2_nfse_received | Este endpoint é responsável por buscar XMLs de NFSes Nota Fiscal de Serviço recebidas, utilizando alguns filtros. Este endpoint, além de retorna o id e XML de uma NFSe, retorna também as properties e valores associados a esta NFSe. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retor | limit (integer) cursor (integer) id (array) cnpj (array) filter (string) created_atfrom (string) created_atto (string) format_type (string) xml_format (string) |
| put_v1_nfse_received_by_property | Através deste endpoint é possível adicionar ou atualizar o valor de uma Property customizada para um determinado documento. A property funciona como um par chave-valor para um documento, permitindo que o usuário indique um valor qualquer para a property que deseja. Por padrão sua conta já possui uma property com chave 'status', sendo possível atribuir valores para esta propery para cada documento. Estes valores podem depois ser utilizados no parâmetro 'filter' do endpoint de GET. | role (string) required property (string) required data: { . data } (object) required |
| get_v1_nfse_by_role_manual_pdf | Recupera o arquivo PDF de uma NFSe que foi ingerida pelo fluxo de OCR. Este endpoint espera como parâmetro o id da NFSe, que pode ser obtido através do endpoint /v1/nfse/received e o CNPJ owner desta NFSe. O arquivo PDF é retornado encoded em base64 | role (string) required id (string) cnpj (string) |
| get_v1_nfse_events | Este endpoint é responsável por buscar eventos de NFSes. Todos os eventos de NFSe serão disponibilizados. Hoje temos dois cenários para as NFSes consultadas: consulta prefeituras e consulta ambiente nacional: - Para as notas de Ambiente Nacional, serão retornados os XMLs, visto que estes são disponibilizados pela SEFAZ. - Para as notas de prefeitura, será disponibilizado apenas o 'tipo' do evento, sendo 101101 o tipo de cancelamento, visto que as prefeituras não disponibilizam um XML. | id (array) type (array) limit (integer) cursor (integer) |
| get_v1_nfse_danfse | Este endpoint é responsável por realizar a busca do Documento Auxiliar DANFSe de uma NFSe, sendo retornado um PDF formatado em base64 | id (string) required |
| get_v1_cte_by_role | Este endpoint é responsável por buscar XMLs de CTes tomadas, utilizando alguns filtros. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campos created_atfrom e created_atto definem um range de bus | role (string) required limit (integer) cursor (integer) access_key (array) cnpj (array) filter (string) created_atfrom (string) created_atto (string) format_type (string) |
| put_v1_cte_by_role_by_property | Através deste endpoint é possível adicionar ou atualizar o valor de uma Property customizada para um determinado documento. A property funciona como um par chave-valor para um documento, permitindo que o usuário indique um valor qualquer para a property que deseja. Por padrão sua conta já possui uma property com chave 'status', sendo possível atribuir valores para esta propery para cada documento. Estes valores podem depois ser utilizados no parâmetro 'filter' do endpoint de GET. | role (string) required property (string) required data: { . data } (object) required |
| get_v1_cte_events | Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos de uma CTe, retornados em base64. Todos os Eventos de uma CTe disponibilizados pela SEFAZ são retornados, sendo possível buscar apenas uma chave de acesso por vez. | access_key (string) required |
| get_v2_cte_events | Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos CTe da conta autenticada, retornados em base64. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campo 'type' repres | access_key (array) type (array) limit (integer) cursor (integer) |
| post_v1_cte_upload | Este endpoint é responsável por fazer o upload de um lote de XMLS de CTes. O processo é feito de forma assíncrona, tendo como retorno um request_id que deve ser utilizado no endpoint /v1/cte/upload/status para acompanhar o status do lote. Pode ser passado uma url de callback no banco callback_url. Caso seja feito, será realizado um callback com o resultado do processamento. | data: { . invoices (array) . callback_url (string) } (object) required |
| get_v1_cte_upload_status | Este endpoint é responsável por retornar os status do upload de um lote de CTes. Deve ser utilizado o request_id retornado no endpoint /v1/cte/upload para verificação. Exemplo: GET /nfe/upload/status?request_id=string | request_id (string) |
| get_v1_cte_dacte | Este endpoint é responsável por realizar a busca do Documento Auxiliar DACTe de uma CTe, retornando um PDF em base64, | access_key (string) required |
| post_v1_dfe_cteos | Este endpoint permite buscar todos os CTe-OS da conta, retornando os dados conforme a projeção solicitada, com suporte a filtros avançados como chave de acesso, CNPJ do emitente, tomador, status e intervalo de datas. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . Fields (array) . Filters (object) . Limit (integer) . Paginator (string) } (object) required |
| get_v1_cte_os_by_role | Este endpoint é responsável por buscar XMLs de CTes-OS tomadas, utilizando alguns filtros. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campos created_atfrom e created_atto definem um range de | role (string) required limit (integer) cursor (integer) access_key (array) cnpj (array) filter (string) created_atfrom (string) created_atto (string) |
| put_v1_cte_os_by_role_by_property | Através deste endpoint é possível adicionar ou atualizar o valor de uma Property customizada para um determinado documento. A property funciona como um par chave-valor para um documento, permitindo que o usuário indique um valor qualquer para a property que deseja. Por padrão sua conta já possui uma property com chave 'status', sendo possível atribuir valores para esta propery para cada documento. Estes valores podem depois ser utilizados no parâmetro 'filter' do endpoint de GET. | role (string) required property (string) required data: { . data } (object) required |
| get_v1_cte_os_events | Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos de uma CTe-OS, retornados em base64. Todos os Eventos de uma CTe-OS disponibilizados pela SEFAZ são retornados, sendo possível buscar apenas uma chave de acesso por vez. | access_key (string) required |
| get_v1_cte_os_dacteos | Este endpoint é responsável por realizar a busca do Documento Auxiliar DACTe de uma CTe-OS, retornando um PDF em base64, | access_key (string) required |
| get_v1_nfce_emitted | Este endpoint é responsável por buscar XMLs de NFCes emitidas, utilizando alguns filtros. - Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0. - O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50. - Campos created_atfrom e created_atto definem um range de b | limit (integer) cursor (integer) access_key (array) cnpj (array) created_atfrom (string) created_atto (string) |
| post_v1_dfe_mdfe | Este endpoint permite buscar todos os MDFes da conta, retornando as chaves de acesso, origens e os XMLs, encodados em base64, dos MDFes obtidos. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . Filter (object) . Limit (integer) . Paginator (string) . Fields (array) } (object) required |
| get_v1_property | Este endpoint é responável por retornar todas as chaves de properties disponíveis para conta, para uso nos endpoints de PUT de property. Example: GET /v1/property | No parameters |
| get_v1_company | Busca todos os CNPJs da conta autenticada | No parameters |
| get_v1_invoice_search | Este endpoint possibilita a busca por invoices internacionais que foram processadas e ingeridas na Qive através de OCR. A resposta retorna um objeto JSON contendo uma lista de invoices. Cada invoice é composta pelos seguintes dados: - ID: Identificador único da invoice na API Qive. - Parsed Document: Uma representação estruturada dos dados invoice. O endpoint retorna um máximo de 50 invoices por página. A busca pode ser filtrada utilizando a data em que o documento foi processado pela Qive. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required initial_date (string) required final_date (string) required page (integer) required |
| get_v1_invoice_by_id | Disponível somente em ambiente de produção. Este endpoint é equivalente ao /v1/invoice/search, mas com a finalidade de retornar um documento específico de invoice a partir de seu identificador único. A resposta será um objeto JSON contendo o documento solicitado, com os seguintes campos: - id: identificador único do documento na API da Qive. - parsed_document: objeto estruturado com os dados extraídos do documento de invoice. Esse recurso é útil para consultas diretas a um documento previame | id (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| get_v1_invoice_by_id_pdf | Disponível somente em ambiente de produção. Este endpoint retorna um documento do tipo invoice em formato PDF, de acordo com o id do documento informado. A resposta é um objeto JSON contendo o conteúdo do PDF no campo pdf_content. O PDF disponibilizado por este recurso não é gerado pela Qive. Trata-se exatamente do arquivo original recebido via endpoint de upload /v1/ocr/upload ou encaminhado para a sua caixa personalizada de OCR. | id (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| get_v1_utility_search | Disponível somente em ambiente de produção. Este endpoint permite a busca por documentos do tipo utility processados por OCR ou importação de XML. Atualmente, suportamos os tipos: - electricity: Notas de energia elétrica ex: modelos 6 e 66, ou NF3-e. - telecom: Notas de telecomunicações ex: modelos 21, 22 e 62. - water: Contas de água e saneamento. - gas: Contas de fornecimento de gás. - generic: Documentos diversos notas de débito, recibos, faturas de locação. A resposta retorna uma lista pa | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required initial_date (string) required final_date (string) required page (integer) required document_types (string) required |
| get_v1_utility_by_document_type_by_id | Disponível somente em ambiente de produção. Este endpoint é equivalente ao /v1/utility/search, mas com a finalidade de retornar um documento específico de utility a partir de seu identificador único. Esse recurso é útil para consultas diretas a um documento previamente conhecido, sem a necessidade de navegação paginada ou filtros adicionais. | id (string) required document_type (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| get_v1_utility_by_document_type_by_id_pdf | Disponível somente em ambiente de produção. Este endpoint retorna um documento o PDF original da Utility, de acordo com o id informado. A resposta é um objeto JSON contendo o conteúdo do PDF no campo pdf_content, codificado em base64. O PDF disponibilizado por este recurso não é gerado pela Qive. Trata-se exatamente do arquivo original recebido via endpoint de upload /v1/ocr/upload ou encaminhado para a sua caixa personalizada de OCR. | id (string) required document_type (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| get_v1_utility_by_document_type_by_id_xml | Disponível somente em ambiente de produção. Este endpoint retorna um documento do tipo utility em formato XML, de acordo com o id informado. A resposta é um objeto JSON contendo o conteúdo do XML no campo xml_content, codificado em base64. Atualmente, este recurso está disponível apenas para documentos processados via XML. A importação de XML de utilities está restrita, no momento, a documentos do tipo electricity no formato XML NF3-e. Portanto, apenas nesses casos é esperado um retorno de su | id (string) required document_type (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| post_v1_ocr_upload | Disponível somente em ambiente de produção. Este endpoint realiza o upload de arquivos PDF para o processo de OCR Reconhecimento Óptico de Caracteres, utilizado na automação do inbound de NFS-e e documentos de consumo utilities. Utilizando um conteúdo misto de tecnologias — desde Machine Learning a IA Generativa — este recurso é capaz de interpretar o conteúdo do PDF recebido, classificar e, estruturar: - Para documentos do tipo NFS-e, em um XML padronizado no layout ABRASF; - Para outros tipo | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . meta (object) . file (string) . filename (string) } (object) required |
| get_v1_ocr_status | Disponível somente em ambiente de produção. Este endpoint permite consultar o status de processamento de um documento enviado via /v1/ocr/upload para o fluxo de OCR Reconhecimento Óptico de Caracteres. Os possíveis valores do campo status_code são: - processing: o documento está em processamento. - success: o documento foi processado com sucesso. - error: ocorreu uma falha durante o processamento. Quando status_code for error, o campo error_code poderá indicar o tipo de erro ocorrido. Atualme | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required message_id (string) |
| get_v1_bank_billet | Este endpoint retorna os boletos com notas baseado em uma série de filtros | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required owners (string) required issue_datefrom (string) issue_dateto (string) due_datefrom (string) due_dateto (string) document_identifier (string) status (string) trust_level (string) linked_document_type (string) updated_atfrom (string) updated_atto (string) page (string) limit (string) |
| post_v2_bank_billet_search | Este endpoint retorna os boletos com notas baseado em uma série de filtros | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . owners (array) . issue_date (object) . due_date (object) . updated_at (object) . document_identifier (string) . status (string) . trust_level (string) . linked_document_type (array) . limit (integer) . next (string) } (object) required |
| get_v1_bank_billet_by_owner_by_digitable_line_pdf | Este endpoint busca o PDF de um boleto de acordo com o owner CNPJ pagador do boleto e a linha digitável. A resposta é um objeto json contendo o PDF encoded em base64. | owner (string) required digitableLine (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| post_v1_account_tags_list | Endpoint responsável por buscar uma lista de etiquetas para uma determinada conta. A resposta é um objeto json contendo os dados das etiquetas buscadas. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . IsLane (boolean) . SearchTerm (string) . TagsIds (array) } (object) required |
| post_v1_dfe_tags_list | Endpoint responsável por buscar uma lista de etiquetas para um determinado documento a partir da seu identificador único. A resposta é um objeto json contendo o identificador do documento e as etiquetas vinculadas a esse documento. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . DocumentType (string) . Identifiers (array) . Owners (array) } (object) required |
| post_v1_dfe_tags_update | Endpoint responsável por aplicar ou remover etiquetas de um documento fiscal. A resposta é um objeto json informando o status e a mensagem da requisição. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . DocumentType (string) . Identifiers (array) . Owners (array) . Tags (object) } (object) required |
| post_v1_certificate_upload | Este endpoint permite enviar um certificado digital para associá-lo a um ou mais documentos CPF ou CNPJ cadastrados na conta. Retorna os dados originais do certificado e a lista de documentos que tiveram o upload realizado com sucesso. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . Certificate (object) . Owners (array) } (object) required |
| post_v1_latam_upload | Disponível apenas em ambiente de produção. Este endpoint realiza o upload de arquivos XML para o processo de padronização e armazenamento de documentos LATAM, utilizado na automação do processo de inbound de documentos. O fluxo suporta o recebimento de XMLs de diferentes países, realizando a conversão para o formato unificado QIVE LATAM. Atualmente, são aceitos documentos dos seguintes países: - México - Chile - Peru - Colômbia Em caso de sucesso no upload, o documento poderá ser consultado | X-API-ID (string) required X-API-KEY (string) required data: { . xml (string) } (object) required |
| get_v1_latam_search | Disponível somente em ambiente de produção. Este endpoint permite a busca por documentos do tipo LATAM que tenham sido previamente enviados pelo endpoint /v1/latam/upload. O retorno deste endpoint é uma lista de documentos em formato unificado em padrão QIVE LATAM. Sempre que houver uma nova página disponível dentro do filtro realizado, o parâmetro page.next estará presente no JSON de retorno. Ao atingir a última página, este parâmetro deixará de ser retornado, indicando que todas as páginas | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required initial_date (string) required final_date (string) required page (integer) required |
| get_v1_latam_by_id | Essa API recebe id de um documento LATAM e retorna o Document encontrado. | id (string) required X-API-ID (string) required X-API-KEY (string) required |
| get_v1_latam_by_id_xml | Essa API recebe owner e id de um documento latam e retorna o XML em base64. Quando não há xml associado ao documento, retorna uma string vazia no campo de xml. | id (string) required X-API-ID (string) required X-API-KEY (string) required |
| post_v1_latam_by_id_cancel | Recebe XMLs de documentos LATAM. | id (string) required X-API-ID (string) required X-API-KEY (string) required |
| get_v1_cnpj | Retorna os dados públicos de uma lista de CNPJs. | cnpj (array) required X-Use-ApiGateway (string) required |
| get_v1_cnpj_by_cnpj | Retorna os dados públicos de um CNPJ. | CNPJ (string) required X-Use-ApiGateway (string) required |
| post_v1_dfe_nfe_events | Endpoint para registro de eventos da reforma tributária relacionados ao documento NF-e, conforme NT 2025.002. | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required data: { . access_key (string) . owner (string) . owner_uf (string) . n_seq_evento (string) . tp_evento (string) . det_evento (object) } (object) required |
| post_v1_event_batch | Este endpoint realiza a recepção de lotes de eventos para processamento assíncrono. O processamento é feito de forma assíncrona e o status pode ser consultado pelo endpoint GET /v1/event/batch/id. Suporta eventos de CT-e, CT-e OS e NF-e, identificados automaticamente pela posição 20-22 da chave de acesso 57=CT-e, 67=CT-e OS, 55=NF-e. Para NF-e, o Número Sequencial do Evento n_seq_evento é obtido automaticamente do SOT durante a ingestão — não deve nem pode ser informado na requisição. Todos os i | X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required X-Flow-Identifier (string) data: { . owner (string) . tp_evento (string) . metadata (object) . items (object) } (object) required |
| get_v1_event_batch_by_id | Este endpoint retorna o status atual de um lote de eventos previamente submetido, incluindo o progresso do processamento e o resultado de cada item. | id (string) required X-API-ID (string) required X-API-KEY (string) required X-Use-ApiGateway (string) required |
| post_v1_receipts_list | Este endpoint permite buscar os comprovantes de pagamento da conta, retornando os dados conforme a projeção solicitada em Fields, com filtros por identificador, data de pagamento, documento do recebedor e faixa de valor. O mesmo endpoint entrega o PDF do comprovante: basta incluir EncodedPdf em Fields. Nesse caso Filters.Identifier passa a ser obrigatório e a quantidade de identificadores por requisição é limitada 2 em produção. A caixa das chaves é exigida. identifier, IDENTIFIER ou limit ret | X-Api-Id (string) required X-Api-Key (string) required X-Use-ApiGateway (string) required data: { . Fields (array) . Filters (object) . Limit (integer) . Paginator (string) } (object) required |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |