NotaFiscal

Busca de Notas Fiscais

Lê uma lista de Notas Fiscais com base no filtro informado na URL da requisição.

get/api/comercial/v1/nota-fiscal

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/comercial/v1/nota-fiscal
  • Auth: HTTP bearer

Query parameters

DataEmissaoInicialstring date
DataEmissaoFinalstring date
NumeroInicialinteger
NumeroFinalinteger
ValorTotalInicialnumber double
ValorTotalFinalnumber double
NumeroNfseInicialinteger
NumeroNfseFinalinteger
ChaveAcessoNfsestring
ChaveAcessoNfestring
CodigoPedidostring
CodigoRastreiostring
IdFilialstring
IdClientesFornecedoresstring[]
IdVendedoresstring[]
IdRepresentantesstring[]
IdTransportadorasstring[]
idProdutostring nullable
idItemGrade1string nullable
idItemGrade2string nullable
idItemGrade3string nullable
IdServicostring
IdNaturezaOperacaoProdutosstring[]
IdNaturezaOperacaoServicosstring[]
TiposRadarAPIModelComercialDtosV1NotaFiscalEnumsTipoNfDto[]
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

Response

OK

idstring nullable
codigoIntegradorstring nullable
chavestring nullable
origemNFstring nullable
idFilialstring nullable
tipo'Entrada' | 'Saida'
finalidade'Normal' | 'Complementar' | 'Ajuste' | 'Devolucao' | 'Credito' | 'Debito' | 'Outros'
finalidadeNfNormalComplemento'Nenhum' | 'NormalOutras'
finalidadeNfAjusteComplemento'Nenhum' | 'AjusteTransferenciaCredito' | 'AjusteAtivoImobilizado'
tipoNfDebito'Nenhum' | 'TransferenciaCreditoCooperativa' | 'AnulacaoCredito' | 'NFNaoProcessadaApuracao' | 'MultaJuros' | 'TransferenciaCreditoSucessao' | 'PagamentoAntecipado' | 'PerdaEstoque' | 'DesenquadramentoSN'
tipoNfCredito'Nenhum' | 'MultaJuros' | 'ApropriacaoCreditoPresumidoZFM' | 'RetornoRecusaTotal' | 'ReducaoValores' | 'TransferenciaCreditoSucessao' | 'RetornoRecusaParcial'
seriestring nullable
numerointeger
idDocumentostring nullable
leiautestring nullable
dataEmissaostring date-time
dataEntradaSaidastring date-time
indicadorPresencaComprador'NaoSeAplica' | 'OperacaoPresencial' | 'OperacaoNaoPresencialInternet' | 'OperacaoNaoPresencialTeleatendimento' | 'NfceEmOperacaoEntregaDomicilio' | 'OperacaoPresencialForaEstabelecimento' | 'OperacaoNaoPresencialOutros'
idClienteFornecedorstring nullable
consumidorFinal'Normal' | 'ConsumidorFinal'
idOperacaoComercialstring nullable
idNaturezaOperacaoProdutostring nullable
idNaturezaOperacaoServicostring nullable
idClassificacaostring nullable
itemNfReferidainteger
tipoRateio'RateioPeloLiquidoDaNf' | 'RateioPorItem' | 'RateioPeloTotalDaNf'

Changes

No recorded changes to this operation across all 1 revision of this API.