Web service Com.senior.g5.co.mct.ctb.custoprodutoperiodo
Este webservice irá exportar os registros adicionados na tela de Custo de produto por data (F075MES). Caso seja inserido/alterado/excluído algum produto, o mesmo será exportado pelo webservice.
Processos
Será obrigatório informar os campos Empresa, Filial, Mês/Ano, Identificador do Sistema e Tipo de Integração.
- Comportamento do campo Tipo de Integração:
- Ao informar o campo Tipo de Integração = T (Todos), o web service irá exportar todos os registros disponíveis;
- Ao informar o campo Tipo de Integração = A (Alterados), o web service irá exportar somente os registros que tiveram alterações na tela acima, e não consumidas anteriormente via webservice;
- Ao informar o campo Tipo de Integração = E (Especifico), obrigatoriamente deve ser informado os campos de Produto, Derivação e Família.
- O Campo Mês/Ano deverá ser informado no padrão data (dd/mm/yyyy).
Caso seja considerado somente o Mês e o Ano desta data, serão apresentados os registros pertencentes a este período completo. Com isto, será retornado a empresa, filial, a configuração de produto (código, derivação, família), o mês/ano informado, e o respectivo preço de custo. Além disso, será retornado os campos de controle, indicando se houve sucesso ou não no retorno dos dados.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_mct_ctb_custoprodutoperiodo?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_ctb_custoprodutoperiodo?wsdl
- Agendamento: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_ctb_custoprodutoperiodo?wsdl
Porta
Controladoria - Gestão de Contabilidade - Distribuição de Custos - Custo de produto por data.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Versão atual: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <identificadorSistema>String</identificadorSistema> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <mesAno>DateTime</mesAno> <codPro>String</codPro> <codDer>String</codDer> <codFam>String</codFam> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
identificadorSistema | String | (Obrigatório) - String(15) - Identificador de Sistema para Integração |
tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de Registros a serem exportados |
mesAno | DateTime | (Obrigatório) | Mês/Ano de competência - Deverá ser informado no formato data (dd/mm/yyy), e será considerado para a busca dos registros sempre o primeiro dia da data informada para compor o Mês/Ano. |
codPro | String | (Opcional) - String(014) - Código do Produto Movimentado |
codDer | String | (Opcional) - String(007) - Código da Derivação do Produto Movimentado |
codFam | String | (Opcional) - String(006) - Código da Família |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarResponse> <result> <erros> <mensagemErro>String</mensagemErro> </erros> <tipoRetorno>Integer</tipoRetorno> <precoCustoProduto> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <mesAno>DateTime</mesAno> <codPro>String</codPro> <codDer>String</codDer> <codFam>String</codFam> <preCus>Double</preCus> </precoCustoProduto> <mensagemRetorno>String</mensagemRetorno> <finalizaramRegistros>String</finalizaramRegistros> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
erros | Set | (Opcional) - Lista de erros |
erros.mensagemErro | String | (Opcional) - Itens da lista de erros |
tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
precoCustoProduto | Set | Preço custo do produto por data |
precoCustoProduto.codemp | Integer | Number(004) - Código da Empresa |
precoCustoProduto.codFil | Integer | Number(005) - Código da Filial |
precoCustoProduto.mesAno | DateTime | |
precoCustoProduto.codPro | String | String(014) - Código do Produto Movimentado |
precoCustoProduto.codDer | String | String(007) - Código da Derivação do Produto Movimentado |
precoCustoProduto.codFam | String | String(006) - Código da Família |
precoCustoProduto.preCus | Double | Number(009,4) - Preço de Custo |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
numeroLote | Integer | Obrigatório - Inteiro - Identificação do Lote de Exportação |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores: - Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |