Skip to main content

Qive

Acesse e gerencie documentos fiscais eletrônicos (NFe, NFSe, CTe, NFCe) com a API da Qive (Arquivei).

Qive Logo

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 72 actions:

ActionPurposeParameters
post_v1_dfe_uploadNeste endpoint é possível fazer o envio de qualquer Documento Fiscal Eletrônico, assim como seus eventos, em formato XML. 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_flagerpEssa 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.data: {
. doc_type (string)
. id (string)
. metadata (array)
. owner (string)
} (object) required
post_v1_dfe_nfseEste endpoint permite buscar todas as NFses da conta, retornando os dados das NFses obtidas.data: {
. fields (array)
. filters (object)
. paginator (string)
} (object) required
get_v1_nfe_receivedEste 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 delimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_nfe_received_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_nfe_emittedEste endpoint é responsável por buscar XMLs de NFEs 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 delimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_nfe_emitted_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_nfe_transporterEste endpoint é responsável por buscar XMLs de NFEs Transportadas, 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 ranglimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_nfe_transporter_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_nfe_authorizedEste endpoint é responsável por buscar XMLs de NFEs Citadas onde o CNPJ owner foi citado na tag autXML, 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_limit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_nfe_authorized_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
post_v1_nfe_uploadEste 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_statusEste 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=stringrequest_id (string)
get_v1_nfe_manifestEste 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_manifestEste 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/exibdata: {
. manifests (array)
} (object) required
get_v1_nfe_manifest_statusEste 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)
get_v1_nfe_manifest_syncNew endpointNo parameters
post_v1_nfe_manifest_syncEste 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/Pmdata: {
. manifests (array)
} (object) required
get_v1_nfse_receivedEste 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_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_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v2_nfse_receivedEste 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 retlimit (integer)
cursor (integer)
id (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
xml_format (string)
get_v1_nfse_received_manual_pdfRecupera 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 base64id (string)
cnpj (string)
get_v1_nfse_emittedEste endpoint é responsável por buscar XMLs de NFSes Nota Fiscal de Serviço 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_alimit (integer)
cursor (integer)
id (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
xml_format (string)
get_v1_nfse_emitted_manual_pdfRecupera 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/emitted e o CNPJ owner desta NFSe. O arquivo PDF é retornado encoded em base64id (string)
cnpj (string)
get_v1_nfse_eventsEste 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_danfseEste endpoint é responsável por realizar a busca do Documento Auxiliar DANFSe de uma NFSe, sendo retornado um PDF formatado em base64id (string) required
get_v1_cte_takerEste 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 blimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_cte_taker_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_cte_not_takerEste 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 blimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
format_type (string)
put_v1_cte_not_taker_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_cte_os_takerEste 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 dlimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
put_v1_cte_os_taker_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_cte_os_not_takerEste endpoint é responsável por buscar XMLs de CTes-OS não 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 ranlimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
filter (string)
created_atfrom (string)
created_atto (string)
get_v1_cte_authorizedEste endpoint é responsável por buscar XMLs de CTes Citadas, 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 blimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
created_atfrom (string)
created_atto (string)
format_type (string)
get_v1_cte_dacteEste endpoint é responsável por realizar a busca do Documento Auxiliar DACTe de uma CTe, retornando um PDF em base64,access_key (string) required
put_v1_cte_os_not_taker_by_propertyAtravé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.property (string)
data: {
. data
} (object) required
get_v1_cte_os_dacteosEste 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_emittedEste 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 delimit (integer)
cursor (integer)
access_key (array)
cnpj (array)
created_atfrom (string)
created_atto (string)
get_v1_propertyEste 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/propertyNo parameters
get_v1_companyBusca todos os CNPJs da conta autenticadaNo parameters
get_v2_nfe_manifestEste 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_danfeEste 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_cte_eventsEste 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_eventsEste 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' repreaccess_key (array)
type (array)
limit (integer)
cursor (integer)
post_v1_cte_uploadEste 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_statusEste 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=stringrequest_id (string)
get_v1_cte_os_eventsEste 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_v2_nfe_eventsEste 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_nfeEste 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' repreaccess_key (array)
cnpj (array)
type (array)
limit (integer)
cursor (integer)
get_v1_invoice_searchEste 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.initial_date (string) required
final_date (string) required
page (integer) required
get_v1_invoice_by_idDisponí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 previameid (string)
get_v1_invoice_by_id_pdfDisponí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)
get_v1_utility_searchDisponível somente em ambiente de produção. Este endpoint permite a busca por documentos do tipo utility. Atualmente, suportamos os tipos: - electricity: modelo 6 e 66. - telecom: modelo 21, 22 e 62. A resposta retorna uma lista paginada máximo de 10 documentos por página, contendo: - id: identificador único do documento na API Qive. - document_type: tipo do documento apresentado. - electricity ou telecom: de acordo com o document_type, a estrutura de campos será retornada seguindo o padrão dinitial_date (string) required
final_date (string) required
page (integer) required
document_types (string) required
get_v1_utility_by_document_type_by_idDisponí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. A resposta será um objeto JSON contendo o documento solicitado, com os seguintes campos: - id: identificador único do documento na API Qive. - document_type: tipo do documento apresentado. - electricity ou telecom: de acordo com o document_type, a estrutura de campos será retornada seguindo o padrid (string)
document_type (string)
get_v1_utility_by_document_type_by_id_pdfDisponível somente em ambiente de produção. Este endpoint retorna um documento do tipo utility 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. Portanto, documentos importados por XML não devem retornar umid (string)
document_type (string)
get_v1_utility_by_document_type_by_id_xmlDisponí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, e não para documentos processados por OCR. A importação de XML de utilities está restrita, no momento, a documentos do tipo electricity no formato XML NF3-e. Portanto, apenid (string)
document_type (string)
post_v1_ocr_uploadDisponí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 tipodata: {
. meta (object)
. file (string)
. filename (string)
} (object) required
get_v1_ocr_statusDisponí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. Atualmemessage_id (string)
get_v1_bank_billetLista todos os boletos com notasowners (array) required
issue_datefrom (string)
issue_dateto (string)
due_datefrom (string)
due_dateto (string)
document_identifier (string)
status (string)
trust_level (string)
linked_document_type (array)
updated_atfrom (string)
updated_atto (string)
page (string)
limit (string)
post_v2_bank_billet_searchConsulta e retorna a listagem de boletos com notas, permitindo paginação via cursor e aplicação de filtros para refinar os resultados.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_pdfEste 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)
digitableLine (string)
post_v1_account_tags_listEndpoint responsável por buscar uma lista de etiquetas para uma determinada conta. A resposta é um objeto json contendo os dados das etiquetas buscadas.data: {
. IsLane (boolean)
. SearchTerm (string)
. TagsIds (array)
} (object) required
post_v1_dfe_tags_updateEndpoint 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.data: {
. DocumentType (string)
. Identifiers (array)
. Owners (array)
. Tags (object)
} (object) required
post_v1_dfe_tags_listEndpoint 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.data: {
. DocumentType (string)
. Identifiers (array)
. Owners (array)
} (object) required
post_v1_certificate_uploadEste endpoint permite o envio de um certificado digital para associá-lo a um ou mais documentos CPF ou CNPJ que já estão registrados na conta. A resposta da API inclui os dados originais do certificado e a lista dos documentos que foram atualizados com sucesso.data: {
. Certificate (object)
. Owners (array)
} (object) required
post_v1_latam_uploadDisponí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 consultadodata: {
. xml (string)
} (object) required
get_v1_latam_searchDisponí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áginasinitial_date (string) required
final_date (string) required
page (integer) required
get_v1_latam_by_idEssa API recebe id de um documento LATAM e retorna o Document encontrado.id (string)
get_v1_latam_by_id_xmlEssa 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)
post_v1_latam_by_id_cancelMarca como CANCELED um documento recebido anteriormente.id (string)
get_v1_cnpjRetorna os dados públicos de um CNPJ.cnpj (array) required
get_v1_cnpj_by_cnpjRetorna os dados públicos de vários CNPJs.CNPJ (string)