Retornar notas fiscais de serviço por filtros

Request

Permite consultar todas as notas fiscais de serviço (NFS-e) já emitidas no ERP, com uso de filtros como data, número da nota, id da venda.. Este endpoint retorna NFS-e com todos os status possíveis a partir da emissão. Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade.

Security

BearerAuth

Query

paginainteger, >= 1

Número da página

Default:1

tamanho_paginainteger

Tamanho da página (valores válidos: 10, 20, 50, 100)

Default:10

Enum:102050100

data_competencia_destringrequired

Data de emissão inicial no formato YYYY-MM-DD (range máximo: 15 dias)

Example:data_competencia_de=2024-01-01

data_competencia_atestringrequired

Data de emissão final no formato YYYY-MM-DD (range máximo: 15 dias)

Example:data_competencia_ate=2024-01-15

idsArray of strings

Lista de UUIDs das notas fiscais de serviço

id_clienteArray of strings

Lista de IDs de clientes (UUIDs)

numero_vendainteger, (int64)

Número da venda

Example:numero_venda=1001

numero_nfse_inicialinteger, (int64)

Número inicial da NFS-e

Example:numero_nfse_inicial=100

numero_nfse_finalinteger, (int64)

Número final da NFS-e

Example:numero_nfse_final=200

numero_rps_inicialinteger, (int64)

Número inicial do RPS

Example:numero_rps_inicial=1000

numero_rps_finalinteger, (int64)

Número final do RPS

Example:numero_rps_final=2000

statusArray of strings

Status da nota fiscal

Items Enum:"PENDENTE""PRONTA_ENVIO""AGUARDANDO_RETORNO""EM_ESPERA""EMITINDO""EMITIDA""CANCELADA""FALHA""FALHA_CANCELAMENTO""CORRIGIDA_SUCESSO"

tipo_negociacaostring

Tipo de negociação

Enum:"VENDA""CONTRATO"

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/notas-fiscais-servico?pagina=1&tamanho_pagina=10&data_competencia_de=2024-01-01&data_competencia_ate=2024-01-15&ids=string&id_cliente=string&numero_venda=1001&numero_nfse_inicial=100&numero_nfse_final=200&numero_rps_inicial=1000&numero_rps_final=2000&status=PENDENTE&tipo_negociacao=VENDA' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

itensArray of objects(NotaFiscalServico)

paginacaoobject(Pagina_o)

Modelo de resposta para paginação dos resultados

Response

{
  "itens": [
    { … }
  ],
  "paginacao": {
    "pagina_atual": 1,
    "tamanho_pagina": 10,
    "total_itens": 50,
    "total_paginas": 5
  }
}