OperacaoComercial

Busca de Operações Comerciais

Lê uma lista de Operações Comerciais com base no filtro informado na URL da requisição.

get/api/empresarial/v1/operacao-comercial

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/empresarial/v1/operacao-comercial
  • Auth: HTTP bearer

Query parameters

IdFilialstring
TipoNf'Todos' | 'Entrada' | 'Saida'
Descricaostring
ClasseProduto'Todos' | 'Classificacao' | 'InfoExtra1' | 'InfoExtra2' | 'InfoExtra3'

Este campo funciona em conjunto com o campo Radar.API.Model.Empresarial.Dtos.V1.OperacaoComercial.OperacaoComercialFiltroTipoOperacaoProdutoDto.Classe.

TipoOperacao.Descricaostring
TipoOperacao.Cliente.IdClientestring

Se informado, as características desse cliente irão sobreescrever os demais campos desse grupo.

TipoOperacao.Cliente.Pessoa'Todos' | 'Fisica' | 'Juridica'
TipoOperacao.Cliente.AlcanceOperacao'Todos' | 'Estadual' | 'Interestadual' | 'Exterior'
TipoOperacao.Cliente.DestinoOperacao'Todos' | 'RevendedorOuIndustrializador' | 'ConsumidorFinal'
TipoOperacao.Cliente.ContribuinteIcms'Todos' | 'Contribuinte' | 'NaoContribuinte' | 'Isento'
TipoOperacao.Cliente.OptanteSimplesNacional'Todos' | 'Sim' | 'Nao'
TipoOperacao.Cliente.BeneficioSuframa'Todos' | 'IcmsEIpi' | 'SomenteIcms' | 'SomenteIPI' | 'Nao'
TipoOperacao.Produto.Tipo'Todos' | 'Proprio' | 'Terceiros'
TipoOperacao.Produto.SubstituicaoTributaria'Todos' | 'Sim' | 'Nao' | 'IcmsRetidoAnteriormente'
TipoOperacao.Produto.OrigemFiscalstring

Tabela "A" – Origem da Mercadoria ou Servico (Nesse caso apenas mercadorias).

TipoOperacao.Produto.Classestring

Este campo funciona em conjunto com o campo Radar.API.Model.Empresarial.Dtos.V1.OperacaoComercial.OperacaoComercialFiltroDto.ClasseProduto.

TipoOperacao.Resultado.IdNaturezaOperacaostring
TipoOperacao.Resultado.IdMensagemstring
TipoOperacao.Resultado.CstIcmsstring
TipoOperacao.Resultado.CstIpistring
TipoOperacao.Resultado.AliquotaIcmsnumber double

Até duas casas decimais.

TipoOperacao.Resultado.ReducaoBaseCalculoIcmsnumber double

Até quatro casas decimais.

TipoOperacao.Resultado.AliquotaIcmsStnumber double

Até duas casas decimais.

TipoOperacao.Resultado.AcrescimoIcmsStnumber double

Até duas casas decimais.

TipoOperacao.Resultado.CstPisstring
TipoOperacao.Resultado.FatorIncidenciaPisEmPercentualboolean
TipoOperacao.Resultado.FatorIncidenciaPisnumber double

Até quatro casas decimais.

TipoOperacao.Resultado.CstCofinsstring
TipoOperacao.Resultado.FatorIncidenciaCofinsEmPercentualboolean
TipoOperacao.Resultado.FatorIncidenciaCofinsnumber double

Até quatro casas decimais.

Situacao'Todos' | 'Inativo' | 'Ativo'
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
codigostring nullable
idFilialstring nullable
tipoNf'Entrada' | 'Saida'
descricaostring nullable
disponivelRadarWebboolean
inativoboolean
classeProduto'Todos' | 'Classificacao' | 'InfoExtra1' | 'InfoExtra2' | 'InfoExtra3'

Changes

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