---
title: "Consulta as notas fiscais por descrição e cliente"
method: GET
path: "/api/NotaFiscal"
tags: ["NotaFiscal"]
---

# Consulta as notas fiscais por descrição e cliente

`GET /api/NotaFiscal`

Esta API oferece às empresas a capacidade de buscar notas fiscais específicas com base em critérios definidos, otimizando o processo de localização e gerenciamento desses documentos.

### Requisição 
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--| 
| DescricaoContains | Texto | Descrição total ou parcial, informada na nota fiscal | Não | 
| ClienteNomeContains | Texto | Nome do cliente total ou parcial, utilizado na nota fiscal | Não |
| Start | Número | Posição do início da consulta | Não | 
| Size | Número | Quantidade de itens retornados | Não | <br /> 

### Resposta
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Id | GUID | Id da nota fiscal | 
| CobrancaId | GUID | Id da cobrança associada a nota fiscal  | 
| ClienteId | GUID | Id do cliente associado a nota fiscal| 
| IdentificadorInterno| Texto | Identificação interna da nota fiscal  | 
| IdentificadorExterno | Texto | Identificação externa da nota fiscal  | 
| DataEmissao | Texto | Data de emissão da nota fiscal  | 
| Situacao | Texto | Situação da nota fiscal | 
| Descricao | Texto | Descrição da nota fiscal | 
| Valor | Número | Valor da nota fiscal | 
| ValorPagamento | Número | Valor da cobrança da nota fiscal | 
| VencimentoPagamento | Texto | Vencimento da cobrança da nota fiscal | 
| DataPagamento | Texto | Data de pagamento da cobrança da nota fiscal | 
| ClienteNome | Texto | Nome do cliente da nota fiscal | 
| NFNumero | Texto | Número da nota fiscal| 
| LinkPDF | Texto |Link do PDF da nota fiscal| 
| LinkXML | Texto | Link do XML da nota fiscal|

## Query parameters

- `NumeroNota` string
- `Serie` string
- `Situacao` 'Pendente' | 'Emitida' | 'Cancelada' | 'Negada' | 'CancelamentoNegado' | 'ACancelar'
- `Descricao` string
- `DataEmissaoIni` string, date-time
- `DataEmissaoFim` string, date-time
- `ClienteId` string, uuid
- `Page` integer
- `PageSize` integer
- `OrderBy` string
- `OrderDirection` 'ASC' | 'DESC'

## Headers

- `Aeskey` string, required

## Response `200`

Notas fiscais consultadas com sucesso

- BknBankCobrancasAPIModelsNotaFiscal[]
  - `Id` string — Id da nota fiscal
  - `CobrancaId` string, uuid — Id da cobrança associada a nota fiscal
  - `ClienteId` string, uuid — Id do cliente associado a nota fiscal
  - `IdentificadorInterno` string — Identificação interna da nota fiscal
  - `IdentificadorExterno` string — Identificação externa da nota fiscal
  - `DataEmissao` string, date-time — Data de emissão da nota fiscal
  - `Situacao` 'Pendente' | 'Emitida' | 'Cancelada' — Situação da nota fiscal
  - `Descricao` string, required — Descrição da nota fiscal
  - `Valor` number, double — Valor da nota fiscal
  - `ValorPagamento` number, double — Valor da cobrança da nota fiscal
  - `VencimentoPagamento` string, date-time — Vencimento da cobrança da nota fiscal
  - `DataPagamento` string — Data de pagamento da cobrança da nota fiscal
  - `ClienteNome` string — Nome do cliente da nota fiscal
  - `NFNumero` string — Número da nota fiscal
  - `LinkPDF` string — Link do PDF da nota fiscal
  - `LinkXML` string — Link do XML da nota fiscal
  - `CodigoVerificacao` string — Código de Verificação da nota fiscal

## Other responses

- `500` — Erro efetuando a consulta

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/versions/14db4977f490/schema)