NotaFiscal

Gravação de Notas Fiscais

Grava uma lista de Notas Fiscais com base no json informado no body da requisição.

post/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

Request body

codigoIntegradorstring nullable
tipoGravacao'Gravar' | 'Emitir' | 'Registrar'

'Registrar' não disponível no momento.

idFilialstring nullable

Se informado nulo, filial será preenchida automaticamente caso exista apenas uma filial ativa para o usuário da requisição.

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'
indicadorPresencaComprador'NaoSeAplica' | 'OperacaoPresencial' | 'OperacaoNaoPresencialInternet' | 'OperacaoNaoPresencialTeleatendimento' | 'NfceEmOperacaoEntregaDomicilio' | 'OperacaoPresencialForaEstabelecimento' | 'OperacaoNaoPresencialOutros'
numerointeger

Só deve ser informado se o TipoGravacao for Registrar (Não disponível).

idDocumentostring nullable
leiautestring nullable

Se informado nulo, o leiaute será preenchido automaticamente caso o documento informado tiver um leiaute vinculado nas propriedades do Comercial.

O campo será desconsiderado caso seja uma NF-e.

dataEmissaostring date-time

Só deve ser informado se o TipoGravacao for Registrar (Não disponível).

dataEntradaSaidastring date-time

Se informado, não pode ser menor que a data e hora de emissão.

idOperacaoComercialstring nullable
idNaturezaOperacaoProdutostring nullable

O campo será desconsiderado caso a nota fiscal não tenha produtos.

idClassificacaostring nullable

O campo será desconsiderado caso a base não utilize classificação empresarial ou a data de emissão seja menor que a data de início da classificação empresarial.

idClienteFornecedorstring required
consumidorFinal'Normal' | 'ConsumidorFinal'

Se não for informado, o tipo será considerado Consumidor Final se no cadastro do cliente/fornecedor, para pessoa jurídica, a opção Consumidor Final estiver selecionada na aba Insc. Legais e, para pessoa física, a opção Isento estiver marcada na aba Inf. Cadastrais.

tipoRateio'RateioPeloLiquidoDaNf' | 'RateioPorItem' | 'RateioPeloTotalDaNf'

Se não informar nenhuma lista de rateios, o sistema vai mudar o tipo de rateio para 'Rateio por item' e preencher conforme tal.

itemNfReferidainteger

Caso queira vincular uma chave de acesso das NFsReferidas como origem da Nota Fiscal informe aqui a posição da chave na lista, começando a partir de 1.

Response

Created

idstring nullable
codigoIntegradorstring nullable

Changes

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