Qive API
Produção: https://api.arquivei.com.br
Teste: https://sandbox-api.arquivei.com.br
NFe
Endpoints utilizados para operações com Notas Fiscais Eletrônicas (NFes). Neste grupo é possível buscar os XMLs, eventos e PDFs de NFes, realizar a Manifestação do Destinatário e fazer a aplicação de valores para as Properties. Os endpoints estão distribuidos por papel (role) do Owner na nota. Para coleta dos documentos, você deve colocar o 'role' como parte da URL requisitada: Ex: /v1/nfe/received - received - recebedor - emitted - emissor - transporter - tranportadora - authorized - autorizado - CNPJ/CPF mencionado no campo autXML.
Lista as NFes da conta com base nos filtros aplicados
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.
Parâmetros
X-API-ID
*required
Type:
string
In:
header
Description:
API ID usado para autenticação.
X-API-KEY
*required
Type:
string
In:
header
Description:
API KEY usado para autenticação.
X-Use-ApiGateway
*required
Type:
string
In:
header
Description:
Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.
Body
Type:
object
In:
body
Description:
A API busca NFes através dos seguintes filtros, que devem ser enviados no corpo da requisição:
Filtros (Filters):
CreatedAt(Objeto comFromeTo) – Filtra os documentos pelo intervalo de data/hora de criação do registro no sistema.EmissionDate(Objeto comFromeTo) – Filtra os documentos pelo intervalo de data/hora de emissão. Caso não informado, será utilizado o padrão de 30 dias.DocumentIdentifier– Chave de Acesso da NFe para busca exata.EmitterCnpj(Array) – Lista de CNPJs/CPFs dos emitentes para filtrar os documentos.TransporterCnpj(Array) – Lista de CNPJs/CPFs dos transportadores para filtrar os documentos.ReceiverCnpj(Array) – Lista de CNPJs/CPFs dos destinatários para filtrar os documentos.Owners(Array) – Lista de CNPJs/CPFs dos proprietários dos documentos na Qive.OwnerRoles(Array) – Lista de papéis do proprietário (ex: "received", "emitted", "transporter").Status– Status do documento. Valores possíveis: "canceled", "authorized".Origin– Origem do documento. Exemplos: "sefaz", "upload", "upload_zip", "upload_daemon", "upload_api", "email", "integracoes".HasCCE(Boolean) – Indica se o documento possui Carta de Correção Eletrônica.HasEvent(Boolean) – Indica se o documento possui eventos associados.HasManifestation(Boolean) – Indica se o documento possui manifestação.HasXPed(Boolean) – Indica se o documento possui xPed.Cfops(Array) – Lista de CFOPs para filtrar os documentos.NfeNumber(Objeto comFromeTo) – Intervalo de números NFe para filtrar os documentos. Composto porFromeTo, sendo "From" o número inicial e "To" o número final.Tags(Array) – Lista de tags para filtrar os documentos.TagsAll(Array) – Lista de tags obrigatórias para todos os documentos retornados.xPeds(Array) – Lista de xPeds para filtrar os documentos.
Fields (campos retornados):
Fields(Array) – Lista de campos específicos da NFe a serem retornados: (ex: "Xml", "Origin", "FlagErp", "Document", "Events", "Tags", "Cfops", "AccessKey", "EmissionDate", "CreatedAt", "HasCCE", "Manifestations", "Number", "Owner", "OwnerRole", "Receiver", "Emitter", "Status"). Caso não informado, serão retornados campos padrão.
Outros parâmetros:
Paginator(String) – Token de paginação (cursor) para buscar próximo conjunto de resultados.Limit– Limite de documentos retornados por requisição (ex: 500)
O endpoint retorna uma lista de NFe com os campos solicitados em `fields.
{
"fields": [
"Xml",
"Origin",
"FlagErp",
"Document",
"Events",
"Tags",
"Cfops",
"AccessKey",
"EmissionDate",
"CreatedAt",
"HasCCE",
"Manifestations",
"Number",
"Owner",
"OwnerRole",
"Receiver",
"Emitter",
"Status"
],
"Filters": {
"CreatedAt": {
"From": "2006-01-02",
"To": "2006-01-02 23:59:59"
},
"EmissionDate": {
"From": "2006-01-02",
"To": "2006-01-02 23:59:59"
},
"DocumentIdentifier": "12345678901234567890123456789012345678901234",
"EmitterCnpj": [
"12345678000195",
"98765432000195"
],
"TransporterCnpj": [
"12345678000195",
"98765432000195"
],
"ReceiverCnpj": [
"12345678000195",
"98765432000195"
],
"Owners": [
"12345678000195",
"98765432000195"
],
"Status": "canceled",
"Origins": [
"sefaz",
"upload"
],
"HasCCE": true,
"HasEvent": true,
"HasManifestation": true,
"HasXPed": true,
"Cfops": [
"5102",
"6102"
],
"NfeNumber": {
"From": 1,
"To": 10
},
"Tags": [
1,
2
],
"TagsAll": [
1,
2
],
"XPeds": [
"12345",
"54321"
],
"OwnerRoles": [
"receiver",
"emitter",
"transporter"
]
},
"Limit": 100,
"paginator": "[\"75e7ccc0a702d0a823a2ef073a023c8fc9afedf7\"]"
}Respostas
HTTPNfeListResponseV2 contém a resposta da chamada para a API de listagem de NFes.
{
"Nfes": [
{
"AccessKey": "string",
"Cfops": [
"string"
],
"CreatedAt": "string",
"Document": {},
"EmissionDate": "string",
"Emitter": {
"EmitterAddressUf": "string",
"EmitterCnpj": "string",
"EmitterCpf": "string",
"EmitterInscription": "string",
"EmitterName": "string",
"EmitterTradingName": "string"
},
"Events": [
{
"type": "string",
"xml": "string"
}
],
"FlagErp": {},
"HasCCE": {},
"Manifestations": [
{
"Active": {},
"CreatedAt": "string",
"Date": "string",
"IsForced": {},
"Protocol": "string",
"Seq": "string",
"Type": "string"
}
],
"Number": "string",
"Origin": "string",
"Owner": "string",
"OwnerRole": "string",
"Receiver": {
"ReceiverAddressUf": "string",
"ReceiverCnpj": "string",
"ReceiverCpf": "string",
"ReceiverInscription": "string",
"ReceiverName": "string",
"ReceiverTradingName": "string"
},
"Status": "string",
"Tags": [
"string"
],
"Xml": "string"
}
],
"Paginator": "string",
"Total": 0
}REDES SOCIAIS
© 2026 Qive. CONSTRUÍDO COM 🧡 EM SÃO CARLOS, A CAPITAL DA TECNOLOGIA
