English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.ger.cad.centrocusto
Web service Com.senior.g5.co.ger.cad.centrocusto
O serviço de Centros de Custos é usado para permitir a exportação de registros com controle de integração utilizando a porta exportar. Esse mesmo serviço também contém portas de consulta que permitem obter informações específicas da entidade principal, podendo realizar alguns filtros pré-definidos no serviço.
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.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- 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
Exemplo:
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.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- 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
Exemplo:
- 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_ger_cad_centrocusto?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_centrocusto?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_ger_cad_centrocusto?wsdl
Portas
Exportar
ExportarRequisição:Parâmetros da requisição:
Resposta:Atributos da resposta:
Após executar o web service será retornado um número de lote, esse número deve ser usado com o código da integração "158" para retornar ao ERP a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao.Confirmar.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 2.
Versão atual: 2.
Requisição:
<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>
<codCcu>String</codCcu>
<codFil>Integer</codFil>
<identificadorSistema>String</identificadorSistema>
<quantidadeRegistros>Integer</quantidadeRegistros>
<tipoIntegracao>String</tipoIntegracao>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codCcu | String | (Opcional) - String(009) - Código do Centro de Custo |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| identificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
Resposta: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>
<mensagemRetorno>String</mensagemRetorno>
<CentrosCusto>
<seqInt>Integer</seqInt>
<codEmp>Integer</codEmp>
<codCcu>String</codCcu>
<desCcu>String</desCcu>
<abrCcu>String</abrCcu>
<codUsu>Double</codUsu>
<tipCcu>Integer</tipCcu>
<indAgr>String</indAgr>
<ccuPai>String</ccuPai>
<agrTax>String</agrTax>
<mskCcu>String</mskCcu>
<claCcu>String</claCcu>
<gruCcu>Integer</gruCcu>
<nivCcu>Integer</nivCcu>
<posCcu>Integer</posCcu>
<anaSin>String</anaSin>
<aceRat>String</aceRat>
<criRat>Integer</criRat>
<ctaRed>Integer</ctaRed>
<ctaRcr>Integer</ctaRcr>
<ctaFdv>Integer</ctaFdv>
<ctaFcr>Integer</ctaFcr>
<claDes>String</claDes>
<codLoc>String</codLoc>
<locRea>String</locRea>
<plaSeg>String</plaSeg>
<taxIcu>Double</taxIcu>
<codTur>Integer</codTur>
<indExp>Integer</indExp>
<datAlt>DateTime</datAlt>
<horAlt>Integer</horAlt>
<usuAlt>Double</usuAlt>
<regExc>String</regExc>
<camposUsuario>
<campo>String</campo>
<valor>String</valor>
</camposUsuario>
</CentrosCusto>
<finalizaramRegistros>String</finalizaramRegistros>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Descrição |
|---|---|---|
| erros | Set | (Opcional) - Lista dos erro |
| 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 |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| centrosCusto | Set | Lista de centros de custo |
| centrosCusto.seqInt | Integer | (Opcional) Number(008) - Número sequencial do registro de exportação |
| centrosCusto.codEmp | Integer | Number(004) - Código da empresa |
| centrosCusto.codCcu | String | String(009) - Código do centro de custos |
| centrosCusto.desCcu | String | String(080) - Descrição do centro de custos |
| centrosCusto.abrCcu | String | String(020) - Abreviatura do centro de custos |
| centrosCusto.codUsu | Double | Number(010) - Código do usuário responsável pelo centro de custos |
| centrosCusto.tipCcu | Integer | Number(001) - Tipo do centro de custos - [ 1=Produtivo/Operacional Indireto;2=Produtivo/Operacional Direto;3=Administrativo;4=Comercial;5=Financeiro ] |
| centrosCusto.indAgr | String | String(001) - Unidade de medida de tempo dos processos - [ M=Minutos;S=Segundos;D=Dias;H=Horas ] |
| centrosCusto.ccuPai | String | String(009) - Código do centro de custos pai |
| centrosCusto.agrTax | String | String(010) - Código do agrupamento para geração de taxa única |
| centrosCusto.mskCcu | String | String(030) - Máscara do centro de custos |
| centrosCusto.claCcu | String | String(020) - Classificação do centro de custos |
| centrosCusto.gruCcu | Integer | Number(001) - Grupo que o centro de custo pertence |
| centrosCusto.nivCcu | Integer | Number(001) - Nível do centro de custos |
| centrosCusto.posCcu | Integer | Number(001) - Quantidade de posições do nível do centro de custos |
| centrosCusto.anaSin | String | String(001) - Indicativo se o centro de custos é analítico ou sintético - [ A=Analítico(a);S=Sintético(a) ] |
| centrosCusto.aceRat | String | String(001) - Indicativo se o centro de custos aceita lançamento de rateio - [ S=Sim;N=Não ] |
| centrosCusto.criRat | Integer | Number(001) - Critério utilizado para rateio do centro de custos - [ 1=Receitas - Conta X C. Custos;2=Receitas - C. Custos X Conta;3=Despesas - Conta X C. Custos;4=Despesas - C. Custos X Conta;5=Nenhum ] |
| centrosCusto.ctaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
| centrosCusto.ctaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
| centrosCusto.ctaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
| centrosCusto.ctaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
| centrosCusto.claDes | String | String(001) - Classificação de despesa - [ A=Depreciação do mês apropriado em custos;G=Depreciação no mês acumulado Despesas ] |
| centrosCusto.codLoc | String | String(009) - Código da localização real do bem de acordo com o organograma |
| centrosCusto.locRea | String | String(025) - Localização real do bem de acordo com organograma |
| centrosCusto.plaSeg | String | String(003) - Código da localização na planta de seguro do bem |
| centrosCusto.taxIcu | Double | Number(005,2) - Taxa de depreciação do bem para custos |
| centrosCusto.codTur | Integer | Number(002) - Código turno para acréscimo da depreciação |
| centrosCusto.indExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
| centrosCusto.datAlt | DateTime | Date(DD/MM/YYYY) - Data da alteração do registro |
| centrosCusto.horAlt | Integer | Number(005) - Hora da alteração do registro |
| centrosCusto.usuAlt | Double | Number(010) - Usuário responsável pela alteração |
| centrosCusto.regExc | String | (Opcional) String(001) - Retorna S se o registro foi excluído no ERP |
| camposUsuario | Set | Lista de campos de usuário |
| camposUsuario.campo | String | Nome do campo |
| camposUsuario.valor | String | Valor do campo |
| 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. |
ConsultarGeral
ConsultarGeral
Esta porta tem a finalidade de somente retornar os registros da consulta.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsultarCentroCustos>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<CodEmp>Integer</CodEmp>
<CodCcu>
<CodCcu>String</CodCcu>
</CodCcu>
<CodFil>Integer</CodFil>
<IdentificadorSistema>String</IdentificadorSistema>
<IndicePagina>Integer</IndicePagina>
<LimitePagina>Integer</LimitePagina>
</parameters>
</ser:ConsultarCentroCustos>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| CodEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| CodCcu | Set | (Opcional) - Lista de abrangência |
| CodCcu.CodCcu | String | (Opcional) - String(009) - Código do Centro de Custo |
| CodFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| IdentificadorSistema | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| IndicePagina | Integer | (Obrigatório) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
| LimitePagina | Integer | (Obrigatório) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
Resposta:
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:ConsultarCentroCustosResponse>
<result>
<Erros>
<MensagemErro>String</MensagemErro>
</Erros>
<MensagemRetorno>String</MensagemRetorno>
<CentrosCusto>
<CodEmp>Integer</CodEmp>
<CodCcu>String</CodCcu>
<DesCcu>String</DesCcu>
<AbrCcu>String</AbrCcu>
<CodUsu>Double</CodUsu>
<TipCcu>Integer</TipCcu>
<IndAgr>String</IndAgr>
<CcuPai>String</CcuPai>
<AgrTax>String</AgrTax>
<MskCcu>String</MskCcu>
<ClaCcu>String</ClaCcu>
<GruCcu>Integer</GruCcu>
<NivCcu>Integer</NivCcu>
<PosCcu>Integer</PosCcu>
<AnaSin>String</AnaSin>
<AceRat>String</AceRat>
<CriRat>Integer</CriRat>
<CtaRed>Integer</CtaRed>
<CtaRcr>Integer</CtaRcr>
<CtaFdv>Integer</CtaFdv>
<CtaFcr>Integer</CtaFcr>
<ClaDes>String</ClaDes>
<CodLoc>String</CodLoc>
<LocRea>String</LocRea>
<PlaSeg>String</PlaSeg>
<TaxIcu>Double</TaxIcu>
<CodTur>Integer</CodTur>
<IndExp>Integer</IndExp>
<DatAlt>DateTime</DatAlt>
<HorAlt>Integer</HorAlt>
<UsuAlt>Double</UsuAlt>
</CentrosCusto>
<TipoRetorno>Integer</TipoRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarCentroCustosResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| Erros | Set | (Opcional) - Lista dos erro |
| Erros.MensagemErro | String | (Opcional) - Itens da lista de erros |
| MensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| CentrosCusto | Set | Lista de centros de custo |
| CentrosCusto.CodEmp | Integer | Number(004) - Código da empresa |
| CentrosCusto.CodCcu | String | String(009) - Código do centro de custos |
| CentrosCusto.DesCcu | String | String(080) - Descrição do centro de custos |
| CentrosCusto.AbrCcu | String | String(020) - Abreviatura do centro de custos |
| CentrosCusto.CodUsu | Double | Number(010) - Código do usuário responsável pelo centro de custos |
| CentrosCusto.TipCcu | Integer | Number(001) - Tipo do centro de custos - [ 1=Produtivo/Operacional Indireto;2=Produtivo/Operacional Direto;3=Administrativo;4=Comercial;5=Financeiro ] |
| CentrosCusto.IndAgr | String | String(001) - Unidade de medida de tempo dos processos - [ M=Minutos;S=Segundos;D=Dias;H=Horas ] |
| CentrosCusto.CcuPai | String | String(009) - Código do centro de custos pai |
| CentrosCusto.AgrTax | String | String(010) - Código do agrupamento para geração de taxa única |
| CentrosCusto.MskCcu | String | String(030) - Máscara do centro de custos |
| CentrosCusto.ClaCcu | String | String(020) - Classificação do centro de custos |
| CentrosCusto.GruCcu | Integer | Number(001) - Grupo que o centro de custo pertence |
| CentrosCusto.NivCcu | Integer | Number(001) - Nível do centro de custos |
| CentrosCusto.PosCcu | Integer | Number(001) - Quantidade de posições do nível do centro de custos |
| CentrosCusto.AnaSin | String | String(001) - Indicativo se o centro de custos é analítico ou sintético - [ A=Analítico(a);S=Sintético(a) ] |
| CentrosCusto.AceRat | String | String(001) - Indicativo se o centro de custos aceita lançamento de rateio - [ S=Sim;N=Não ] |
| CentrosCusto.CriRat | Integer | Number(001) - Critério utilizado para rateio do centro de custos - [ 1=Receitas - Conta X C. Custos;2=Receitas - C. Custos X Conta;3=Despesas - Conta X C. Custos;4=Despesas - C. Custos X Conta;5=Nenhum ] |
| CentrosCusto.CtaRed | Integer | Number(007) - Conta contábil reduzida - 1 |
| CentrosCusto.CtaRcr | Integer | Number(007) - Conta contábil reduzida - 2 |
| CentrosCusto.CtaFdv | Integer | Number(007) - Conta contábil reduzida - 3 |
| CentrosCusto.CtaFcr | Integer | Number(007) - Conta contábil reduzida - 4 |
| CentrosCusto.ClaDes | String | String(001) - Classificação de despesa - [ A=Depreciação do mês apropriado em custos;G=Depreciação no mês acumulado Despesas ] |
| CentrosCusto.CodLoc | String | String(009) - Código da localização real do bem de acordo com o organograma |
| CentrosCusto.LocRea | String | String(025) - Localização real do bem de acordo com organograma |
| CentrosCusto.PlaSeg | String | String(003) - Código da localização na planta de seguro do bem |
| CentrosCusto.TaxIcu | Double | Number(005,2) - Taxa de depreciação do bem para custos |
| CentrosCusto.CodTur | Integer | Number(002) - Código turno para acréscimo da depreciação |
| CentrosCusto.IndExp | Integer | Number(001) - Indicativo se o registro foi alterado para exportar para o palm - [ 0=Para Exportar;1=Em Exportação;2=Exportado;3=Aprovado;4=Em Digitação;5=Aguardando Liberação para Envio;9=Erro ] |
| CentrosCusto.DatAlt | DateTime | Date(DD/MM/YYYY) - Data da alteração do registro |
| CentrosCusto.HorAlt | Integer | Number(005) - Hora da alteração do registro |
| CentrosCusto.UsuAlt | Double | Number(010) - Usuário responsável pela alteração |
| TipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitaçã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. |
English
Español
