OrdemCompra

Busca de Ordens de Compra

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

get/api/compras/v1/ordem-compra

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/compras/v1/ordem-compra
  • Auth: HTTP bearer

Query parameters

IdFornecedorTransportadorstring
IdEmpresaFilialFaturamentostring
DataEmissaoInicialstring date
DataEmissaoFinalstring date
DataHoraBaseAlteracaostring date-time
Codigostring
tipo'Produto' | 'Servico'
idstring nullable
idItemGrade1string nullable
idItemGrade2string nullable
idItemGrade3string nullable
tipo'Produto' | 'Servico'
idstring nullable
idItemGrade1string nullable
idItemGrade2string nullable
idItemGrade3string nullable
IdClassificacaostring
IdGerencialstring
IdRequisitantestring
IdDepartamentostring
IdCompradorstring
SituacaoAutorizacao'Pendente' | 'Autorizada' | 'AutorizadaNaDataInformada' | 'Vetada'

Caso for Radar.API.Model.Compras.Dtos.V1.OrdemCompra.Read.TipoSituacaoAutorizacaoOrdemCompraDto.AutorizadaNaDataInformada, depende do valor de Radar.API.Model.Compras.Dtos.V1.OrdemCompra.Read.OrdemCompraFiltroDto.NaDataInformada.

NaDataInformadastring date

Caso Radar.API.Model.Compras.Dtos.V1.OrdemCompra.Read.TipoSituacaoAutorizacaoOrdemCompraDto seja informada como Radar.API.Model.Compras.Dtos.V1.OrdemCompra.Read.TipoSituacaoAutorizacaoOrdemCompraDto.AutorizadaNaDataInformada, busca exclusivamente por Ordens de Compra autorizadas na data informada.

SituacaoAtendimento'Pendente' | 'ParcialmenteAtendida' | 'Atendida' | 'Cancelada'
SituacaoIntegracao'Integrada' | 'Pendente'
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
codigostring nullable
dataEmissaostring date
dataCompetenciastring date
dataNecessidadestring date
idFilialEmitentestring nullable
idFilialFaturamentostring nullable
idNaturezaOperacaoProdutostring nullable
idNaturezaOperacaoServicostring nullable
idFornecedorTransportadorstring nullable
idClassificacaostring nullable
idGerencialstring nullable
idRequisitantestring nullable
idDepartamentostring nullable
idCompradorstring nullable
idMoedastring nullable
observacoesstring nullable
bloqueioOrcamentoExcedenteboolean
impressaboolean
freteboolean
incompletaboolean
situacaoAutorizacao'Pendente' | 'Autorizada' | 'AutorizadaNaDataInformada' | 'Vetada'
situacaoAtendimento'Pendente' | 'ParcialmenteAtendida' | 'Atendida' | 'Cancelada'
situacaoIntegracao'Integrada' | 'Pendente'
situacaoEnvioEmailFornecedorOrdemCompra'Vazio' | 'Pendente' | 'Enviado'

Changes

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