Busca eventos de NFse.
Este 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.
Request
- Base URL: https://api.arquivei.com.br
- URL: https://api.arquivei.com.br/v1/nfse/events
- Auth: none declared
Query parameters
O id de uma NFSe. Exemplo: /v1/nfse/events?id[]=11223344556677889900112233445566778899001122
Um Array com os tipos de eventos a serem filtrados. Cada tipo de evento é uma string de 6 dígitos string, exemplo: /v1/nfse/events?type[]=101101&type[]=105102' Existem diversos tipos de evento, sendo o principal utilizado tipo 101101, para Cancelamento de uma NFSe
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.
Response
Successful fetch
Example response
{
"data": [
{
"access_key": "1122334455667788990011223344556677889900",
"type": "210210",
"xml": "SXNzbyBuw6NvIMOpIHVtIGV2ZW50byBkZSBORmUh"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.