Utilities
Busca por documentos de Utilities (Energia, Água, Gás, Telecom e Genéricos)
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 paginada (máximo de 50 documentos por página). Sempre que houver uma nova página disponível, o parâmetro page.next estará presente no JSON de retorno.
Para que os documentos estejam disponíveis neste recurso, é necessário realizar o envio do PDF para a sua caixa de OCR personalizada ou através do endpoint /v1/ocr/upload.
get/v1/utility/search
Request
- Base URL: https://api.arquivei.com.br
- URL: https://api.arquivei.com.br/v1/utility/search
- Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway
Query parameters
initial_datestring date-time required
Data inicial da ingestão do documento pela Qive. Formato: 2025-01-23T00:00:00Z.
final_datestring date-time required
Data final da ingestão do documento pela Qive. Formato: 2025-01-23T23:59:59Z.
pageinteger required
Página atual da busca.
document_typesstring required
Lista de tipos separados por vírgula. Tipos suportados: electricity, telecom, water, gas, generic.
Headers
X-API-IDstring required
API ID usado para autenticação.
X-API-KEYstring required
API KEY usado para autenticação.
X-Use-ApiGatewaystring required
Indica roteamento pelo API Gateway da Qive.
Response
Busca realizada com sucesso.
Example response
{
"data": [
{
"electricity": {
"access_key": "00000000000000000000000000000000000000000000",
"consumer_unit": "9876543",
"currency": "BRL",
"due_date": "2025-06-16",
"emission_date": "2025-05-20",
"invoice_id": "888777666",
"nf_number": "999888777",
"reference_month": "2025-05-01",
"total_amount": "541.87",
"boleto": {
"digitable_line": "00000000000000000000000000000000000000000000000"
},
"emitter": {
"name": "DISTRIBUIDORA DE ENERGIA NACIONAL S.A.",
"tax_id": "00111222000133"
},
"taker": {
"name": "RENOVAVEL GERACAO DE ENERGIA S.A.",
"tax_id": "00000"
},
"items": [
{
"amount": "271.43",
"description": "Consumo-TUSD"
},
{
"amount": "198.38",
"description": "Consumo-TE"
}
],
"taxes": {
"icms": {
"amount": "95.4",
"base": "477",
"tax_rate": "20"
}
}
},
"gas": {
"consumption": "1035.544",
"currency": "BRL",
"customer_code": "1234567",
"due_date": "2025-07-15",
"emission_date": "2025-06-17",
"invoice_id": "12345678",
"reading_date": "2025-06-13",
"reference_month": "2025-06-01",
"total_amount": "8702.71",
"boleto": {
"amount": "8702.71",
"digitable_line": "000000000000000000000000000000000000000000000000",
"due_date": "2025-07-15"
},
"emitter": {
"name": "GAS TOTAL DISTRIBUIDORA S.A.",
"tax_id": "00111222000133"
},
"taker": {
"name": "RESTAURANTE E COMERCIO MODELO S.A."
},
"items": [
{
"amount": "8702.71",
"description": "GLP GRANEL - PTP"
}
]
},
"water": {
"consumption": "22.000",
"currency": "BRL",
"customer_code": "0 000 000 000 0",
"due_date": "2025-01-19",
"emission_date": "2025-01-03",
"invoice_id": "999 888 777 66",
"reading_date": "2024-12-30",
"reference_month": "2025-01-01",
"total_amount": "377.00",
"boleto": {
"amount": "377",
"digitable_line": "000000000000000000000000000000000000000000000000",
"due_date": "2025-01-19"
},
"emitter": {
"name": "SANEAMENTO VIRTUAL S.A.",
"tax_id": "00111222000133"
},
"taker": {
"name": "EMPRESA EXEMPLO LTDA"
},
"items": [
{
"amount": "214.11",
"description": "ABASTECIMENTO DE AGUA"
},
{
"amount": "158.43",
"description": "ESGOTO DINAMICO COM COLETA E TRATAMENTO EDT"
}
]
},
"telecom": {
"cfop": "5307",
"currency": "BRL",
"emission_date": "2025-05-03",
"nf_number": "999888777666555",
"serie": "B47",
"total_amount": "89.88",
"boleto": {
"amount": "126.04",
"digitable_line": "00000000000000000000000000000000000000000012604",
"due_date": "2025-05-20"
},
"emitter": {
"name": "NEXUS TELECOMUNICACOES S.A.",
"tax_id": "00111222000133"
},
"taker": {
"name": "TECHNOVA SOLUCOES DIGITAIS LTDA",
"tax_id": "99888777000166"
},
"items": [
{
"amount": "89.88",
"description": "60GB - Plano Internet Ilimitado"
}
],
"taxes": {
"icms": {
"amount": "16.18",
"base": "89.88",
"tax_rate": "18"
}
}
},
"generic": {
"additional_information": "Locação de bens móveis são amparados por não incidência da retenção...",
"document_id": "999/2026",
"due_date": "2026-02-28",
"emission_date": "2026-02-28",
"sub_type": "RECIBO",
"total_amount": "41370",
"emitter": {
"name": "TERRA FORTE LOCACOES E EQUIPAMENTOS LTDA",
"tax_id": "00111222000133"
},
"taker": {
"name": "CONSTRUTORA HORIZONTE PLANO S.A.",
"tax_id": "99888777000166"
},
"items": [
{
"amount": "21000",
"description": "Locação Escavadeira 5870 ref. Medição 156960 de 01-01-26 até 31-01-26"
},
{
"amount": "4480",
"description": "DESCONTO"
}
]
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.