NotaFiscal
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 |
|---|---|---|---|
| NumeroNota | Texto | Número da nota fiscal | Não |
| Serie | Texto | Série da nota fiscal | Não |
| Situacao | Texto | Situação da nota fiscal (Pendente, Emitida, Cancelada) | Não |
| Descricao | Texto | Descrição total ou parcial, informada na nota fiscal | Não |
| DataEmissaoIni | Data | Data de emissão inicial | Não |
| DataEmissaoFim | Data | Data de emissão final | Não |
| ClienteId | GUID | Id do cliente associado a nota fiscal | Não |
| Page | Número | Número da página para paginação | Não |
| PageSize | Número | Quantidade de itens por página | Não |
| OrderBy | Texto | Campo para ordenação | Não |
| OrderDirection | Texto | Direção da ordenação (ASC ou DESC) | 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 | Data | 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 associada à nota fiscal |
| VencimentoPagamento | Data | Data de vencimento da cobrança associada à nota fiscal |
| DataPagamento | Data | Data de pagamento da cobrança associada à 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 |
| CodigoVerificacao | Texto | Código de verificação da nota fiscal |
get/api/NotaFiscal
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/NotaFiscal
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Query parameters
NumeroNotastring
Número da nota fiscal
Seriestring
Série da nota fiscal
Situacao'Pendente' | 'Emitida' | 'Cancelada' | 'Negada' | 'CancelamentoNegado' | 'ACancelar'
Situação da nota fiscal
Descricaostring
Descrição da nota fiscal
DataEmissaoInistring date-time
Data de emissão inicial
DataEmissaoFimstring date-time
Data de emissão final
ClienteIdstring uuid
Id do cliente
Pageinteger
Número da página
PageSizeinteger
Quantidade de itens por página
OrderBystring
Campo para ordenação
OrderDirection'ASC' | 'DESC'
Direção da ordenação (ASC ou DESC)
Headers
Aeskeystring required
Response
Notas fiscais consultadas com sucesso
Example response
[
{
"CobrancaId": "00000000-0000-0000-0000-000000000000",
"ClienteId": "00000000-0000-0000-0000-000000000000"
}
]Changes
No recorded changes to this operation across all 1 revision of this API.