Web service Com.senior.g5.co.int.venda.cartadecorrecao
Web service para cadastro de carta de correção eletrônica.
Observação
Este web service realiza apenas a criação da carta de correção. Caso seja necessário integrar com o software de documento eletrônico, este processo deve ser feito manualmente por meio da tela F140CCE ou de forma automatizada utilizando a porta EmitirCartaCorrecao do web service Com.senior.g5.co.int.venda.documentofiscal.
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_int_venda_cartadecorrecao?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_venda_cartadecorrecao?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_int_venda_cartadecorrecao?wsdl
Porta
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Gravar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <cartaCorrecao> <codEmp>String</codEmp> <codFil>String</codFil> <codSnf>String</codSnf> <numNfv>Integer</numNfv> <desCor>String</desCor> <sitCce>String</sitCce> <numPrt>String</numPrt> <datEve>DateTime</datEve> <horEve>String</horEve> <datAut>DateTime</datAut> <horAut>String</horAut> <codTra>String</codTra> <cifFob>String</cifFob> <qtdEmb>String</qtdEmb> <pesBru>String</pesBru> <pesLiq>String</pesLiq> <plaVei>String</plaVei> <seqIpv> <seqIpv>String</seqIpv> <nopPro>String</nopPro> </seqIpv> </cartaCorrecao> </parameters> </ser:Gravar> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
cartaCorrecao | Obrigatório | Set | Cadastro de carta de correção |
cartaCorrecao.codEmp | Obrigatório | Número | Código da empresa |
cartaCorrecao.codFil | Obrigatório | Número | Código da empresa |
cartaCorrecao.codSnf | Obrigatório | String | Código da série da nota fiscal |
cartaCorrecao.numNfv | Obrigatório | Número | Número da nota fiscal de saída |
cartaCorrecao.desCor | Obrigatório | String | Descrição da correção a ser considerada |
cartaCorrecao.sitCce | Obrigatório | String | Situação do evento |
cartaCorrecao.numPrt | Opcional | String | Número do protocolo de autorização oi recebimento - (Obrigatório quando Sitcce igual a 3(Autorizada) ou 5(Denegada)) |
cartaCorrecao.datEve | Obrigatório | Data | Data do evento - DateTime(DD/MM/AAAA) |
cartaCorrecao.horEve | Obrigatório | String | Hora do evento - Time(hh:mm) |
cartaCorrecao.datAut | Opcional | Data | Data do protocolo de autorização - DateTime(DD/MM/AAAA) - (Obrigatório quando Sitcce igual a 3(Autorizada) ou 5(Denegada)) |
cartaCorrecao.horAut | Opcional | String | Hora do protocolo de autorização - Time(hh:mm) - (Obrigatório quando Sitcce igual a 3(Autorizada) ou 5(Denegada)) |
cartaCorrecao.codTra | Opcional | Número | Código da transportadora |
cartaCorrecao.cifFob | Opcional | String | Indicativo se o valor do frete é CIF ou FOB |
cartaCorrecao.qtdEmb | Opcional | Número | Quantidade de embalagens da nota fiscal de saída |
cartaCorrecao.pesBru | Opcional | Número | Peso bruto da nota fiscal de saída |
cartaCorrecao.pesLiq | Opcional | Número | Peso líquido da nota fiscal de saída |
cartaCorrecao.plaVei | Opcional | String | Placa do veículo de transporte das mercadorias da nota fiscal de saída |
seqIpv | Opcional | Set | Atualizar item na nota fiscal de saída. |
seqIpv.seqIpv | Opcional | String | Sequência do item na nota fiscal de saída |
seqIpv.nopPro | Opcional | String | Código da natureza da operação |
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:GravarResponse> <result> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:GravarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipoRetorno | Opcional | Integer | Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
mensagemRetorno | Opcional | String | Mensagem de retorno da situação da execução do serviço |
erroExecucao | Opcional | 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. |