v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBNotaFiscal
Consulta as notas fiscais por descrição e cliente
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 |
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 |
get/api/NotaFiscal
Query parameters
NumeroNotastring
Seriestring
Situacao'Pendente' | 'Emitida' | 'Cancelada' | 'Negada' | 'CancelamentoNegado' | 'ACancelar'
Descricaostring
DataEmissaoInistring date-time
DataEmissaoFimstring date-time
ClienteIdstring uuid
Pageinteger
PageSizeinteger
OrderBystring
OrderDirection'ASC' | 'DESC'
Headers
Aeskeystring required
Response
Notas fiscais consultadas com sucesso
Example response
[
{
"CobrancaId": "00000000-0000-0000-0000-000000000000",
"ClienteId": "00000000-0000-0000-0000-000000000000"
}
]