English
Español
Web service Com.senior.g5.co.mct.imp.reinf.receitasrecebidas
Este web service permite importar as receitas recebidas.
Observação
Caso seja passado um registro com os mesmos campos-chave, o sistema vai editar o registro existente em vez de bloquear a informação. Confira a tabela com a chave de negócio que será verificada em cada web service.
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://servidor:1234/g5-senior-services/sapiens_Synccom_senior_g5_co_mct_imp_reinf_receitasrecebidas?wsdl`
- Assíncrono: `http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_imp_reinf_receitasrecebidas?wsdl`
- Agendado: `http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_imp_reinf_receitasrecebidas?wsdl`
Porta(s)
Importar
Situação da versão: atual.
Versão: 2.
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Importar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<cliente>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<numCgc>Double</numCgc>
<docIde>String</docIde>
<datCpt>DateTime</datCpt>
<codCli>Integer</codCli>
<cgcCpf>Double</cgcCpf>
<docIdeCli>String</docIdeCli>
<receita>
<tipRep>Integer</tipRep>
<desRep>String</desRep>
<vlrBrt>Double</vlrBrt>
<vlrRet>Double</vlrRet>
<processos>
<codDfs>Double</codDfs>
<codSus>Double</codSus>
<vlrRet>Double</vlrRet>
</processos>
</receita>
</cliente>
</parameters>
</ser:Importar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| client | Set | Opcional | Cliente |
| cliente.codEmp | Integer | Opcional | Number(004) - Opcional - Código da empresa |
| cliente.codFil | Integer | Opcional | Number(004) - Opcional - Código da filial |
| cliente.numCgc | Double | Opcional | Number(015) - Obrigatório quando não informar "codEmp" e "codFil" - Número do cadastro nacional de pessoa jurídica da filial da empresa |
| cliente.docIde | String | Opcional | String(014) - CNPJ Alfa. da filial |
| cliente.datCpt | DateTime | Opcional | Date(MM/YYYY) - Obrigatório - Data de Competência |
| cliente.cgcCpf | Integer | Opcional | Number(009) - Opcional - Código do Cliente |
| cliente.cgcCpf | Double | Opcional | Number(015) - Obrigatório quando não informar "codCli" - Número do CNPJ ou CPF do cliente |
| cliente.docIdeCli | String | Opcional | String(014) - CNPJ Alfa. do cliente |
| receita | Set | Opcional | Receitas recebidas através repasse de outras empresas |
| receita.tipRep | Integer | Opcional | Number(001) - Obrigatório - Tipo de Repasse - [ 1=Patrocínio;2=Licenciamento de marcas e símbolos;3=Publicidade;4=Propaganda;5=Transmissão de espetáculos ] |
| receita.desRep | String | Opcional | String(020) - Obrigatório - Descrição Resumida do Repasse |
| receita.vlrBrt | Double | Opcional | Number(015,2) - Obrigatório - Valor Bruto do repasse efetuado |
| receita.vlrRet | Double | Opcional | Number(015,2) - Obrigatório - Vlr. Retenção |
| processos | Set | Opcional | Informações de processos relacionados a não retenção de contribuição previdenciária. |
| processos.codDfs | Double | Opcional | Código do Dispositivo Fiscal |
| processos.codSus | Double | Opcional | Obrigatório - Código da suspensão |
| processos.vlrRet | Double | Opcional | Number(015,2) - Obrigatório - Valor da retenção de contribuição previdenciária principal que deixou de ser efetuada em função de processo administrativo ou judicial |
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:ImportarResponse>
<result>
<retorno>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<numCgc>Double</numCgc>
<docIde>String</docIde>
<datCpt>DateTime</datCpt>
<codCli>Integer</codCli>
<cgcCpf>Double</cgcCpf>
<docIdeCli>String</docIdeCli>
<tipRet>String</tipRet>
<msgRet>String</msgRet>
</retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ImportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| retorno | Set | Retorno |
| retorno.codEmp | Integer | Number(004) - Código da empresa |
| retorno.codFil | Integer | Number(005) - Código da filial |
| retorno.numCgc | Double | Number(015) - Número do cadastro nacional de pessoa jurídica da filial da empresa |
| retorno.docIde | String | String(014) - CNPJ Alfa. da filial |
| retorno.datCpt | DateTime | DateTime(DD/MM/YYYY) - Competência |
| retorno.codCli | Integer | Number(009) - Código do Cliente |
| retorno.cgcCpf | Double | Number(015) - Número do CNPJ ou CPF do cliente |
| retorno.docIdeCli | String | String(014) - CNPJ Alfa. do cliente |
| retorno.tipRet | String | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
| retorno.msgRet | String | String(1000) - Mensagem de Retorno de Processamento |
| 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
English
Español
