Consulta as notas fiscais por IdEmpresa filtros
Changed onEsta 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 para pesquisa | Não |
| Serie | Texto | Série das notas para pesquisa | Não |
| Situacao | Texto | Situação das Notas pesquisadas | Não |
| Descricao | Texto | Descrição das Notas pesquisadas | Não |
| DataEmissaoIni | Data | Range inicial de data da emissão das notas | Não |
| DataEmissaoFim | Data | Range final de data de emissão das notas | Não |
| ClienteId | Texto | Id único do Cliente que emitiu a nota | Não |
| Page | Número | Número da página, sendo 0 o número da primeira página | Não |
| PageSize | Número | Total de itens a serem retornados por página, sendo 10 o padrão quando não informado | Não |
| OrderBy | Número | Campo no qual será aplicado a ordenação da pesquisa (opções: emissao, cliente, valor, descricao) | Não |
| OrderDirection | Número | Direção na qual será feita a ordenação da pesquisa | Não |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Id da nota fiscal |
| TransacaoId | GUID | Id da transação 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 |
| MotivoStatusNF | Texto | Motivo do Status da nota fiscal |
| Descricao | Texto | Descrição da nota fiscal |
| Valor | Número | Valor da nota fiscal |
| ValorPagamento | Número | Valor da transação associada à nota fiscal |
| VencimentoPagamento | Data | Data de vencimento da transação associada à nota fiscal |
| DataPagamento | Data | Data de pagamento da transação 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 |
Request
- Base URLhttps://pagamentos.meuk8.com.br/PagamentosAPI
- URLhttps://pagamentos.meuk8.com.br/PagamentosAPI/api/NotaFiscal
- AuthOAuth 2PasswordToken URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI
Query parameters
Número da Nota Fiscal que deseja consultar
Série das notas fiscais para pesquisa
Situacao das notas fiscais para pesquisa
Descricao das notas fiscais para pesquisa
Data inicial de Emissão para pesquisa de um range de notas fiscais
Data Final de Emissão para pesquisa de um range de notas fiscais
Id do cliente das Notas Fiscais
Número da página, sendo 0 o número da primeira página
Total de itens a serem retornados por página
Campo no qual será aplicado a ordenação
Direção na qual será feita a ordenação
Headers
Response
Notas fiscais consultadas com sucesso
Example response
[
{
"CobrancaId": "00000000-0000-0000-0000-000000000000",
"ClienteId": "00000000-0000-0000-0000-000000000000"
}
]Changes
- breaking
the response property
/became optional for the status (media type: application/json) - breaking
the response property
/became optional for the status (media type: text/json) - breaking
the response property
/became optional for the status (media type: application/xml) - breaking
the response property
/became optional for the status (media type: text/xml) - warning
removed the optional property
from the response with the status (media type: application/json) - warning
removed the optional property
from the response with the status (media type: text/json) - warning
removed the optional property
from the response with the status (media type: application/xml) - warning
removed the optional property
from the response with the status (media type: text/xml) - info
api operation id
NotaFiscal_ConsultaNotasFiscaisremoved and replaced withNotaFiscal_ConsultaNotasFiscais_ConsultaNotasFiscais_GET - info
the security scope
BknBankPagamentosAPIwas added to the endpoint's security schemeoauth2 - info
the security scope
BknBankCobrancasAPIwas removed from the endpoint's security schemeoauth2 - info
added the optional property
to the response with the status (media type: application/json) - info
added the optional property
to the response with the status (media type: text/json) - info
added the optional property
to the response with the status (media type: application/xml) - info
added the optional property
to the response with the status (media type: text/xml) - info
added the optional property
to the response with the status (media type: application/json) - info
added the optional property
to the response with the status (media type: text/json) - info
added the optional property
to the response with the status (media type: application/xml) - info
added the optional property
to the response with the status (media type: text/xml) - info
added the required property
/to the response with the status (media type: application/json) - info
added the required property
/to the response with the status (media type: text/json) - info
added the required property
/to the response with the status (media type: application/xml) - info
added the required property
/to the response with the status (media type: text/xml)
- breaking