Busca XMLs de NFSes recebidas pelos CNPJs de sua conta
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 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 id[] - permite filtrar por um conjunto de ids de NFSe - o id é retornado no corpo da resposta.
- Campo format_type - permite retornar os dados do documento em xml ou json.
- Compo filter - permite realizar uma busca utilizando um filtro personalizado, com valores inseridos através do endpoint de PUT /v1/nfse/received/{property}.
- Campo xml_format - permite alternar o formato do XML retornado pela API. Por padrão o formato retornado é o abrasf.
- original: XML Original enviado para a plataforma. Ex: layout do município ou nacional.
- abrasf: XML formato Abrasf Qive.
- abrasf_rtc: XML formato Abrasf Qive com os campos da reforma tributária.
Example: GET /nfse/received?filter=(= processed false)&id[]=40charkey&limit=50
Request
- Base URL: https://api.arquivei.com.br
- URL: https://api.arquivei.com.br/v2/nfse/received
- Auth: none declared
Query parameters
Quantidade de XMLs retornados na resposta. Máximo 50 documentos. Caso não seja enviado, serão retornados 50 documentos.
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.
Filtrar uma lista de ids. Exemplo de uso deste filtro: v1/nfse/received?id[]=40charKey
Filtrar por uma lista de CNPJs ou CPFs. Examplo de uso deste filtro: v1/nfse/received?cnpj[]=34174654000153&cnpj[]=34174654000215
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"
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/nfse/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.
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/nfse/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.
Formata a resposta em JSON ou XML
Permite alternar o formato do XML retornado pela API. Por padrão o formato retornado é o abrasf.
- original: XML Original enviado para a plataforma. Ex: layout do município ou nacional.
- abrasf: XML formato Abrasf Qive.
- abrasf_rtc: XML formato Abrasf Qive com os campos da reforma tributária.
Response
Successful fetch
Changes
No recorded changes to this operation across all 1 revision of this API.