Métodos
Esta interface disponibiliza os seguintes métodos:
Busca de ordens de compra baseando-se no filtro. Este método aceita requisições via WEB API. OrdemCompra[] BuscarOrdensCompras(Login login, FiltroOrdemCompra filtro);
Altera o estado da autorização das ordens de compra informadas, definindo a assinatura delas para o valor informado em “Acao”. Este valor será aplicado somente para a assinatura do usuário enviado em “login”. Este método aceita requisições via WEB API.
void AlterarAutorizacaoOrdemCompra(Login login, AlterarAutorizacaoOrdemCompraParam dados);
Busca as informações referentes ao valor orçado de acordo com o filtro. Este método aceita requisições via WEB API.
ValorOrcadoRealizado[] BuscarValoresOrcadosRealizados(Login login, FiltroValoresOrcadosRealizados filtro);
Busca um resumo da quantidade de ordens de compra registradas na base de dados de acordo com o filtro. Este método aceita requisições via WEB API.
ResumoMovimentacoesOrdensCompra BuscarResumoMovimentacoesOrdensCompra(Login login, FiltroResumoMovimentacoesOrdensCompra filtro);
Busca uma lista de solicitações de compras presentes na base de acordo com as informações definidas no filtro. Junto a solicitação e compras são retornados os dados de acompanhamento da solicitação de compras.
SolicitacaoCompras[] BuscarSolicitacoesCompras(Login login, FiltroSolicitacaoCompras filtro);
Busca uma única solicitação de compras da base de acordo com as informações definidas no filtro. Junto a solicitação e compras são retornados os dados de acompanhamento da solicitação de compras.
SolicitacaoCompras LerSolicitacaoCompras(Login login, FiltroSolicitacaoCompras filtro);
Grava solicitação de compras. Este método permite gravar e alterar solicitações de compras.
Enumerações
Para as enumerações, o primeiro valor apresentado pode ser considerado o valor padrão quando associado a um campo nas classes.
Enumeração FiltroSituacaoAutorizacaoOrdemCompra SOAP JSON
NENHUM = 0 0
PENDENTES = 1 1
AUTORIZADOS = 2 2
MINHA_AUTORIZACAO_PENDENTE = 4 4
VETADOS = 8 8
Enumeração SituacaoAutorizacaoOrdemCompra SOAP JSON
PENDENTE = 0 0
AUTORIZADO = 1 1
AUTORIZADO_NA_DATA_INFORMADA = 2 2
VETADO = 3 3
Enumeração FiltroTipoPeriodoValoresOrcadosRealizados SOAP JSON
ORCAMENTARIO = 0 0
MENSAL = 1 1
Enumeração SituacaoSolicitacaoCompra SOAP JSON
NUNHUM = 0 0 GRAVADA = 1 1 ENCERRADA = 2 2 PARCIALMENTE_ENCERRADA = 3 3 AGRUPADA = 4 4 PARCIALMENTE_AGRUPADA = 5 5 DESCARTADA = 6 6
Enumeração SituacaoCotacao SOAP JSON
NAO_INICIADA = 0 0 EM_ANDAMENTO = 1 1 ENCERRADA = 2 2 INTERROMPIDA = 3 3 COTADA = 4 4 PARCIALMENTE_ENCERRADA = 5 5
Enumeração SituacaoOrdemCompras SOAP JSON
PENDENTE = 0 0
PARCIALMENTE_ATENDIDA = 1 1
ATENDIDA = 2 2
CANCELADA = 3 3
INCOMPLETA = 5 5 ORCAMENTO_EXCEDENTE = 6 6
Classes
A seguir serão apresentadas as classes contidas nesta interface.
Classe FiltroOrdemCompra
1 Codigo String Código da Ordem de Compra
2
DataInicial String
Data Inicial a ser considerada (no formato ‘dd/MM/yyyy’)
3
DataFinal String
Data Final a ser considerada (no formato ‘dd/MM/yyyy’)
4
CodigoFornecedor String
Código do Fornecedor da Ordem de Compra
5
Situacao FiltroSituacaoAutorizacaoOrdemCompra
Situação da autorização da Ordem de Compra
6
DataAutorizacao String
Data de autorização da Ordem de Compra, irá buscar registros com data de autorização igual ou superior a informada. Esta informação só será considerada caso no filtro seja enviado na "Situacao” a flag "AUTORIZADOS" ativa.
7
SomenteNaDataAutorizacao Bool
Indicador de que, ao adquirir as Ordens de Compra, devem ser considreados apenas as que
possuem data de autorização igual a informada em "DataAutorizacao". Esta informação só será considerada caso no filtro seja enviado na "Situacao” a flag "AUTORIZADOS" ativa.
8
BuscarItens Bool
Indicador se, ao adquirir as Ordens de Compra, devem ser lidos os dados dos itens da Ordem de Compra.
9
BuscarParcelas Bool
Indicador se, ao adquirir as Ordens de Compra, devem ser lidos os dados das parcelas da Ordem de Compra. 10 BuscarInformacaoGED Bool Indicação de aquisição da informação "PossuiDocumentoGED" 11 BuscarAutorizacoes Bool
Indicador se, ao adquirir as Ordens de Compra, devem ser lidos os dados das autorizações da Ordem de Compra.
Classe ItemOrdemCompra
1 EhServico Bool Identificador se o item é um serviço
2 CodigoItem String Código do item
3 NomeItem String Nome do item
4 CodigoDeBarras String Código de barras do item
5 DescricaoGrade1 DescricaoGrade Descrição da Grade1(somente produto) do item 6 DescricaoGrade2 DescricaoGrade Descrição da Grade2(somente produto) do item 7 DescricaoGrade3 DescricaoGrade Descrição da Grade3(somente produto) do item
8 Complemento String Complemento do item 9
CodigoUnidadeMedida String
Código da Unidade de Medida do item
10 Quantidade String Quantidade do item 11 ValorUnitario String Valor unitário do item
12 ValorTotal String Valor total do item
13 Rateios RateioEmpresarial[] Lista dos rateios do item 14 Complemento String Complemento do item
Classe AutorizacaoOrdemCompra
1 Usuario Usuario
Informações do usuário responsável pela assinatura da autorização
2 DataAssinatura String Data da assinatura
3 HoraAssinatura String Hora da assinatura 4 Situacao SituacaoAutorizacaoOrdemCompra Situação da assinatura
5 DataAutorizar String Data da autorização da assinatura Classe ParcelaOrdemCompra
1 NumeroParcela String Número da parcela
2 DataVencimento String Data de vencimento da parcela
3
CodigoFormaPagamento String
Código da forma de pagamento da parcela
4
DescricaoFormaPagamento String
Descrição da forma de pagamento da parcela
5
CodigoTipoVencimento String
Código do tipo de vencimento da parcela
6
DescricaoTipoVencimento String
Descrição do tipo de vencimento da parcela
7 Valor String Valor da parcela
Classe OrdemCompra
1
SituacaoAutorizacao SituacaoAutorizacaoOrdemCompra
Situação da ordem de compra, esta informação só será preenchida caso no filtro seja enviado
"BuscarAutorizacoes” como "true"
2 Codigo String Código da ordem de compra
4
DataEmissao String
Data de emissão da ordem de compra
5 FilialEmitente String Filial emitente da ordem de compra 6
CodigoFornecedor String
Código do fornecedor da ordem de compra 7 CNPJFornecedor String CNPJ do Fornecedor da ordem de compra 8 NomeFornecedor String
Nome do fornecedor da ordem de compra
9 ValorTotal String Valor total da ordem de compra
10
PossuiDocumentoGED Bool
Indicação que o título possui documentos vinculados no GED, esta informação só será preenchida caso no filtro seja enviado
"BuscarInformacaoGED” como "true"
11 Itens ItemOrdemCompra[] Itens da ordem de compra 12 Parcelas ParcelaOrdemCompra[] Parcelas da ordem de compra 13 Autorizacoes AutorizacaoOrdemCompra[] Autorizações da ordem de compra
14 Observacao String Observação da ordem de compra 15
CodigoRequisitante String
Código do requisitante da ordem de compra
16
CodigoComprador String
Código do comprador da ordem de compra
Classe AlterarAutorizacaoOrdemCompraParam 1 Codigos String[]
Códigos das Ordens de Compras que serão alteradas
2
Acao SituacaoAutorizacaoOrdemCompra
Situação de autorização para qual será alterada as ordens de compra
3
DataAutorizacao String
Data para autorização da assinatura (no formato 'dd/MM/yyyy'), só será utilizado caso a 'Acao' seja
AUTORIZADO_NA_DATA_INFORMA DA
Classe FiltroValoresOrcadosRealizados 1 TipoPeriodo
FiltroTipoPeriodoValoresOrcadosRealiza
dos Tipo do período a ser avaliado
2
DataInicial String
Data Inicial a ser considerada (no formato ‘dd/MM/yyyy’)
3
DataFinal String
Data Final a ser considerada (no formato ‘dd/MM/yyyy’)
4 CodigoFilial String Código da filial
5 CodigoContaContabil String Código da conta contábil 6 CodigoContaGerencial String Código da conta gerencial 7
Totalizar Bool
Indicação se deve retornar no último registro a totalização dos valores
Classe ValorOrcadoRealizado
1 DataInicial String
Data inicial do periodo ao qual o valor se refere
2
DataFinal String
Data final do periodo ao qual o valor se refere
3 ValorOrcado String Valor orçado
4 ValorRealizado String Valor realizado 5
Percentual String
Percentual do valor realizado em relação ao valor orçado
Classe FiltroResumoMovimentacoesOrdensCompra
1 CodigoFilial String Código da filial Classe ResumoMovimentacoesOrdensCompra
1
QuantidadeOrdensCompraPend entes
MinhaAutorizacao
String Quantidade de ordens de compras com status de autorização
"Pendente de minha autorização"
2
QuantidadeOrdensCompraPend entes
MinhaAutorizacaoAVencerHoje
String Quantidade de ordens de compras com status de autorização
"Pendente de minha autorização" e que possui a data de vencimento igual a data atual
3
QuantidadeOrdensCompraPend entes
MinhaAutorizacaoVencidos
String Quantidade de ordens de compras com status de autorização
"Pendente de minha autorização" e que possui a data de vencimento inferior a data atual
Classe FiltroSolicitacaoCompras
1
DataInicial String Busca somente as solicitações de compra com data de
emissão/vencimento a partir da Data (no formato 'dd/MM/yyyy') informada
2
DataFinal String Busca somente as solicitações de compra com data de vencimento inferior a Data (no formato 'dd/MM/yyyy') informada
3
ChaveInicial String Chave inicial do filtro de solicitação de compras a ser considerado no filtro.
4
ChaveFinal String Chave final do filtro de solicitação de compras a ser considerado no filtro.
5 CodigoSolicitacao String Código da solicitação de compras a
ser considerado no filtro.
6 Situacao SituacaoSolicitacaoCompra Situação da solicitação de compras a
ser considerada no filtro.
7
BuscarAcompanhamento Bool Indicador para o filtro buscar ou não o acompanhamento das solicitações de compras.
8
BuscarDadosInfoPlus Bool Indicação de inclusão dos dados referentes a InfoPlus durante a leitura da solicitação de compra. Classe AcompanhamentoSolicitacaoCompras (somente leitura)
1 Codigo String Código do Item.
2 CodigoUnidadeMedida String Codigo da unidade de medida. 3 Complemento String Complemento do item.
4 Quantidade String Quantidade do item.
5 ChaveCotacao String Chave da cotação.
6 SituacaoCotacao SituacaoCotacao Situação da cotação.
7 ChaveOrdemCompra String Chave da ordem de compra.
8 SituacaoOrdemCompra SituacaoOrdemCompras Situação da ordem de compra.
9 CodigoRegistroEntrada String Código do registro de entrada. Classe ItemSolicitacaoCompras
1 EhServico Bool Identificador se o item é um serviço.
2 Codigo String
Código do Item do item da solicitação de compras. 3 CodigoUnidadeMedida String
Codigo da unidade de medida do item da solicitação de compras.
4 DescricaoGrade1 DescricaoGrade
Descrição da Grade1(somente produto) do item da solicitação de compras.
5 DescricaoGrade2 DescricaoGrade
Descrição da Grade2(somente produto) do item da solicitação de compras.
6 DescricaoGrade3 DescricaoGrade
Descrição da Grade3(somente produto) do item da solicitação de compras.
7 Complemento String
Complemento do item da solicitação de compras.
8 Quantidade String
Quantidade do item da solicitação de compras.
9 CasasDecimaisQuantidade CasasDecimais
Casas decimais da quantidade do item da solicitação de compras.
10 DataNecessidade String
Data de necessidade do item da solicitação de compras.
11 Observacao String
Observação do item da solicitação de compras.
13 RateiosEmpresariais RateioEmpresarial[]
Rateios Contábeis/Gerenciais do item.
Classe FornecedorSolicitacaoCompras
1 Codigo String Código do fornecedor.
2 Nome String Nome do fornecedor.
3 Observacao String Observação do fornecedor.
Classe SolicitacaoCompras
1 Chave String Chave da solicitação de compras. 2 Codigo String Código da solicitação de compras. 3 CodigoFilial String Código da filial da solicitação de
compras.
4 DataNecessidade String
Data de necessidade da solicitação de compras.
5 DataSolicitacao String
Data da solicitação de compras (somente leitura).
6 CodigoFilialAtendente String
Código da filial atendente da solicitação de compras.
7 CodigoFilialRequisitante String
Código da filial requisitante da solicitação de compras.
8 LocalEntrega String
Local de entrega da solicitação de compras. 9 CodigoRequisitante String Código do requisitante da solicitação de compras. 10 CodigoDepartamento String Código do departamento da solicitação de compras. 11 CodigoComprador String
Código do comprador da solicitação de compras.
12 Observacoes String
Observações da solicitação de compras.
13 SituacaoSolicitacao SituacaoSolicitacaoCompras
Situação da solicitação de compras (somente leitura).
14 ItensSolicitacaoCompra ItemSolicitacaoCompras[]
Lista dos itens da solicitação de compras.
15 FornecedoresSolicitacaoCompra FornecedorSolicitacaoCompras[]
Lista dos fornecedores da solicitação de compras.
16 DadosInfoPlus InfoPlus[]
Lista de info plus da solicitação de compras.
17 Acompanhamento AcompanhamentoSolicitacaoCompras[]
Lista do acompanhamento da solicitação de compras. (Somente leitura)