Treeunfe API B2C home pagelight logo
  1. NFS-e
  2. Listar NFS-e
GET
/nfse
curl --request GET \
     --url https://api.treeunfe.com.br/api/v1/nfse \
     --header 'x-api-key: <api-key>' \
     --header 'x-api-key: <x_api_key>'

Lista as NFS-e da empresa. Filtre por situação, tomador, chave de acesso, ambiente e outros critérios.

​
Autenticação

x-api-key
required
string

API Key da empresa.

​
Parâmetros de consulta

page
integer

Número da página. Padrão: 1.

per_page
integer

Itens por página. Padrão: 20; máximo: 50.

listaFiltro
string

Situação: pendente, cancelada, emitida ou recebidas (sempre em minúsculas).

tpAmb
string

Ambiente: HOMOLOGACAO ou PRODUCAO. Quando informado, lista só as notas daquele ambiente.

dpsId
string

ID da DPS na Treeunfe.

nfseId
string

ID da NFS-e autorizada.

chaveAcesso
string

Chave de acesso da NFS-e.

externalId
string

Identificador da nota no seu sistema.

tomadorDoc
string

CNPJ ou CPF do tomador.

search
string

Texto livre para busca.

sortField
string

Campo usado na ordenação.

sortOrder
string

Direção da ordenação.

​
Respostas

StatusDescrição
200Lista paginada de NFS-e.
400Parâmetros inválidos.
401x-api-key ausente ou inválida.
429Limite de requisições excedido.
curl -X GET "https://api.treeunfe.com.br/api/v1/nfse?page=1&per_page=20&listaFiltro=emitida" \
  -H "x-api-key: SUA_API_KEY"