NotaFiscal

Consulta as notas fiscais por IdEmpresa filtros

Changed on

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

CampoTipoDescriçãoObrigatório
NumeroNotaTextoNúmero da nota fiscal para pesquisaNão
SerieTextoSérie das notas para pesquisaNão
SituacaoTextoSituação das Notas pesquisadasNão
DescricaoTextoDescrição das Notas pesquisadasNão
DataEmissaoIniDataRange inicial de data da emissão das notasNão
DataEmissaoFimDataRange final de data de emissão das notasNão
ClienteIdTextoId único do Cliente que emitiu a notaNão
PageNúmeroNúmero da página, sendo 0 o número da primeira páginaNão
PageSizeNúmeroTotal de itens a serem retornados por página, sendo 10 o padrão quando não informadoNão
OrderByNúmeroCampo no qual será aplicado a ordenação da pesquisa (opções: emissao, cliente, valor, descricao)Não
OrderDirectionNúmeroDireção na qual será feita a ordenação da pesquisaNão

Resposta

CampoTipoDescrição
IdGUIDId da nota fiscal
TransacaoIdGUIDId da transação associada a nota fiscal
ClienteIdGUIDId do cliente associado a nota fiscal
IdentificadorInternoTextoIdentificação interna da nota fiscal
IdentificadorExternoTextoIdentificação externa da nota fiscal
DataEmissaoTextoData de emissão da nota fiscal
SituacaoTextoSituação da nota fiscal
MotivoStatusNFTextoMotivo do Status da nota fiscal
DescricaoTextoDescrição da nota fiscal
ValorNúmeroValor da nota fiscal
ValorPagamentoNúmeroValor da transação associada à nota fiscal
VencimentoPagamentoDataData de vencimento da transação associada à nota fiscal
DataPagamentoDataData de pagamento da transação associada à nota fiscal
ClienteNomeTextoNome do cliente da nota fiscal
NFNumeroTextoNúmero da nota fiscal
LinkPDFTextoLink do PDF da nota fiscal
LinkXMLTextoLink do XML da nota fiscal
CodigoVerificacaoTextoCódigo de Verificação da Nota Fiscal
get/api/NotaFiscal

Request

  • Base URL
    https://pagamentos.meuk8.com.br/PagamentosAPI
  • URL
    https://pagamentos.meuk8.com.br/PagamentosAPI/api/NotaFiscal
  • Auth
    OAuth 2
    Password
    Token URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI

Query parameters

NumeroNotastring

Número da Nota Fiscal que deseja consultar

Seriestring

Série das notas fiscais para pesquisa

Situacao'Pendente' | 'Emitida' | 'Cancelada' | 'Negada' | 'CancelamentoNegado' | 'ACancelar'

Situacao das notas fiscais para pesquisa

Descricaostring

Descricao das notas fiscais para pesquisa

DataEmissaoInistring date-time

Data inicial de Emissão para pesquisa de um range de notas fiscais

DataEmissaoFimstring date-time

Data Final de Emissão para pesquisa de um range de notas fiscais

ClienteIdstring uuid

Id do cliente das Notas Fiscais

Pageinteger

Número da página, sendo 0 o número da primeira página

PageSizeinteger

Total de itens a serem retornados por página

OrderBystring

Campo no qual será aplicado a ordenação

OrderDirection'ASC' | 'DESC'

Direção na qual será feita a ordenação

Headers

Aeskeystring required

Response

Notas fiscais consultadas com sucesso

Idstring

Id da nota fiscal

CobrancaIdstring uuid

Id da cobrança associada a nota fiscal

ClienteIdstring uuid

Id do cliente associado a nota fiscal

IdentificadorInternostring

Identificação interna da nota fiscal

IdentificadorExternostring

Identificação externa da nota fiscal

DataEmissaostring date-time

Data de emissão da nota fiscal

Situacao'Pendente' | 'Emitida' | 'Cancelada'

Situação da nota fiscal

MotivoStatusNFstring required

Descrição da nota fiscal

Descricaostring

Descrição da nota fiscal

Valornumber double

Valor da nota fiscal

ValorPagamentonumber double

Valor da cobrança da nota fiscal

VencimentoPagamentostring date-time

Vencimento da cobrança da nota fiscal

DataPagamentostring

Data de pagamento da cobrança da nota fiscal

ClienteNomestring

Nome do cliente da nota fiscal

NFNumerostring

Número da nota fiscal

LinkPDFstring

Link do PDF da nota fiscal

LinkXMLstring

Link do XML da nota fiscal

CodigoVerificacaostring

Código de Verificação da nota fiscal

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_ConsultaNotasFiscais removed and replaced with NotaFiscal_ConsultaNotasFiscais_ConsultaNotasFiscais_GET

    • info

      the security scope BknBankPagamentosAPI was added to the endpoint's security scheme oauth2

    • info

      the security scope BknBankCobrancasAPI was removed from the endpoint's security scheme oauth2

    • 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)