NFS-e
Listar NFS-e emitidas
Lista as NFS-e numeradas da empresa, paginadas por data de emissão, para conciliação.
/openapi/v2/empresas/{empresaId}/nfse/emitidastoken, timestamp e sign, veja Autenticação.Para conciliação: lista os documentos numerados emitidos por esta empresa. Uma tarefa que falhou antes da numeração (status de consulta Falha) não tem linha de documento e não aparece aqui; consulte-a pelo id em Consultar NFS-e. Os itens têm forma compacta: eventos, eco dos parâmetros e motivos de rejeição estão em Consultar NFS-e; para buscar um único documento pela chave de 50 dígitos veja Consultar NFS-e emitida por chave. Documentos antigos de São Paulo não têm chave de 50 dígitos: chaveAcesso fica vazio, então concilie por id ou identificacaoDps.
Parâmetros de caminho
empresaId* | string | Identificador da empresa |
* Campo obrigatório
Parâmetros de consulta
dataInicio | string | Início da janela |
dataFim | string | Fim da janela |
status | string | Filtro de status |
serie | string | Série |
tomadorCpfCnpj | string | Documento do tomador |
chaveAcesso | string | Chave de acesso |
id | string | Id do documento |
pagina | int | Página |
tamanho | int | Tamanho da página |
* Campo obrigatório
itens é um array vazio.pagina | int | Página devolvida |
tamanho | int | Tamanho da página aplicado |
total | int | Total de documentos |
totalLimitado | bool | Total limitado |
| array | Documentos da página |
statusStatus do documento
Filtro exato; um valor fora da lista é recusado na aceitação. Falha não existe na lista: consulte a tarefa pelo id.
| Valores | Significado |
|---|---|
| Pendente | Aceito, ainda sem veredito; cobre a fila, o envio e a conciliação |
| Autorizada | Emitida com sucesso; pode ser cancelada ou substituída |
| Negada | Recusada pela autoridade; terminal |
| EmProcessoDeCancelamento | Pedido de análise de cancelamento aceito, aguardando o município |
| Cancelada | Cancelada; terminal |
| Substituida | Substituída por outra nota; chaveSubstituta traz a nova chave; terminal |
itens[].statusStatus do documento
O status Falha (falha antes da numeração) nunca aparece aqui: nesse caso nenhum documento foi criado, consulte a tarefa pelo id em Consultar NFS-e.
| Valores | Significado |
|---|---|
| Pendente | Aceito, ainda sem veredito; cobre a fila, o envio e a conciliação |
| Autorizada | Emitida com sucesso; pode ser cancelada ou substituída |
| Negada | Recusada pela autoridade; terminal |
| EmProcessoDeCancelamento | Pedido de análise de cancelamento aceito, aguardando o município |
| Cancelada | Cancelada; terminal |
| Substituida | Substituída por outra nota; chaveSubstituta traz a nova chave; terminal |
itens[].padraoMunicipalPadrão municipal
| Valores | Significado |
|---|---|
| Nacional | Padrão nacional: emissor nacional e distribuição nacional |
| Paulistana | Sistema próprio do município de São Paulo |
| Código | HTTP | |
|---|---|---|
| 10001012 | 400 | A janela dataInicio / dataFim passa de 31 dias. Estreite a janela e pagine por períodos. |
| 10001001 | 400 | status fora da enumeração, ou pagina / tamanho fora do intervalo. |
| 10003000 | 404 | empresaId não existe ou não pertence a esta aplicação. |