Skip to content
API/
Notas fiscais
/
/
Retornar notas fiscais de...

Notas fiscais (v1)

Endpoints openapi responsável pelo contexto de notas fiscais

Download OpenAPI description
open-api-invoice.json
open-api-invoice.yaml
Overview
Languages
Servers
https://api-v2.contaazul.com
Mock server
https://developers.contaazul.com/_mock/open-api-docs/open-api-invoice

v1

Operações relacionadas a notas fiscais

Operations

Retornar as notas fiscais por filtro

Request

Security
BearerAuth
Query
data_inicialstringrequired

Data inicial no formato YYYY-MM-DD

data_finalstringrequired

Data final no formato YYYY-MM-DD

paginainteger

Página

Default 1
tamanho_paginainteger

Tamanho da página

Default 10
documento_tomadorstring

Documento do tomador

numero_notastring

Número da nota fiscal

id_vendastring

ID da venda

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/notas-fiscais?data_inicial=string&data_final=string&pagina=1&tamanho_pagina=10&documento_tomador=string&numero_nota=string&id_venda=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itensArray of objects(NotaFiscal)

Lista de notas fiscais

paginacaoobject

Paginação

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

Retornar notas fiscais de serviço por filtros

Request

Retorna lista paginada de notas fiscais de serviço geradas no ERP aplicando os filtros informados. O range entre data_competencia_de e data_competencia_ate não pode exceder 15 dias.

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
Enum102050100
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
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&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
application/json
{
  "itens": [
    { … }
  ],
  "paginacao": {
    "pagina_atual": 1,
    "tamanho_pagina": 10,
    "total_itens": 50,
    "total_paginas": 5
  }
}

Vincular nota fiscal a mdfe

Request

Security
BearerAuth
Bodyapplication/jsonrequired

Dados para vincular nota fiscal a mdfe

chaves_acessoArray of stringsrequired

Chaves de acesso das notas fiscais vinculadas ao MDF-e

Example: ["42250323643586000108550010000001151606401726","42250323643586000108550010000001141054498495"]
identificadorstringrequired

Identificador do MDF-e

Example: "345345"
statusstring

Status do MDF-e

Enum"AUTORIZADO""ENCERRADO""CANCELADO"
Example: "ENCERRADO"
curl -i -X POST \
  https://api-v2.contaazul.com/v1/notas-fiscais/vinculo-mdfe \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "chaves_acesso": [
      "42250323643586000108550010000001151606401726",
      "42250323643586000108550010000001141054498495"
    ],
    "identificador": "345345",
    "status": "ENCERRADO"
  }'

Responses

No Content

Response
No content

Retornar a nota fiscal por chave

Request

Security
BearerAuth
Path
chavestringrequired

Chave da nota fiscal

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/notas-fiscais/{chave}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/xml
string
Response
application/xml
<root>string</root>