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 do Owner na nota: - received - recebedor - emitted - emissor - transporter - tranportadora - authorized - autorizado - CNPJ/CPF mencionado no campo autXML.
Busca XMLs de NFes recebidas pelos CNPJs de sua conta
GET
/v1/nfe/received
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_at[from] e created_at[to] definem um range de buscar por datas em que a nota entrou na API - estes campos não se referem à data de emissão da nota e sim a sua criação na Qive.
- Campo cnpj[] - utilizado para filtrar pelos CNPJs que são 'owner' do documento.
- Campo access_key[] - permite filtrar por um conjunto de chaves de acesso.
- Compo filter - permite realizar uma busca utilizando um filtro personalizado, com valores inseridos através do endpoint de PUT /v1/nfe/received/{property}.
Example:
GET /nfe/received?filter=(= processed false)&access_key[]=44charkey&limit=50
Parâmetros
limit
Type:
integer
In:
query
Description:
Quantidade de XMLs retornados na resposta. Máximo 50 documentos. Caso não seja enviado, serão retornados 50 documentos.
cursor
Type:
integer
In:
query
Description:
O cursor define a posição a partir da qual serão buscados os documentos. Este valor será retorno no campo data.page.next após uma requisição bem sucedida, com o valor do próximo cursor a ser buscado.
access_key
Type:
array[string]
In:
query
Description:
Filtrar uma lista de chaves de acesso. Exemplo de uso deste filtro: v1/nfe/received?access_key[]=44charKey
cnpj
Type:
array[string]
In:
query
Description:
Filtrar por uma lista de CNPJs ou CPFs. Examplo de uso deste filtro: v1/nfe/received?cnpj[]=34174654000153&cnpj[]=34174654000215
filter
Type:
string
In:
query
Description:
Filtrar pela presença de um valor para uma custom property, de acordo com a nossa Query Language. Este filtro utiliza uma linguagem pré-fixada, onde os operadores são colocados antes dos operandos. Operadores disponíveis:
- = - Exemplo: filter=(= processed true) - busca notas onde a property "processed" possui o valor "true"
- NOT_EXISTS - Exemplo: filter=(NOT_EXISTS processed) - busca notas onde não existe valor para a property "processed"
- AND - Exemplo: filter=(AND (= processed true) (= status 200)) - busca notas onde a property "processed" possui o valor "true" E a property "status" possui o valor "200"
- OR - Exemplo: filter=(OR (= processed true) (= status 200)) - busca notas onde a property "processed" possui o valor "true" OU a property "status" possui o valor "200"
created_at[from]
Type:
string
In:
query
Description:
Filtrar por datas de criação da nota na API. Este campo é obrigatório quando o campo created_at[to] for utilizado. Examplo de uso = /v1/nfe/received?created_at[from]=2019-09-12 15:30:25&created_at[to]=2019-09-15 15:30:25. <br> Pode ser utilizado datetime ou apenas date.
created_at[to]
Type:
string
In:
query
Description:
Filtrar por datas de criação da nota na API. Este campo é obrigatório quando o campo created_at[from] for utilizado. Examplo de uso = /v1/nfe/received?created_at[from]=2019-09-12 15:30:25&created_at[to]=2019-09-15 15:30:25. <br> Pode ser utilizado datetime ou apenas date.
Respostas
Headers
X-RateLimit-Limit
integer
Número de requisições permitidas para o período
X-RateLimit-Remaining
integer
Número de requisições ainda disponíveis para serem feitas no período
Successful fetch
{
"status": {
"code": 0,
"message": "string"
},
"data": [
{
"access_key": "string",
"xml": "string"
}
],
"page": {
"next": "string",
"previous": "string"
},
"count": 0,
"signature": "string"
}
