English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.mcm.ven.faturas
Web service Com.senior.g5.co.mcm.ven.faturas
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_mcm_ven_faturas?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mcm_ven_faturas?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mcm_ven_faturas?wsdl
Porta
GravarFatura
Mercado - Gestão de Faturamento e Outras Saídas - Faturas - Gravar Fatura
Necessita autenticação: Sim
Situação de 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:GravarFatura>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<opcaoTitulo>Integer</opcaoTitulo>
<fatura>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<numNff>Integer</numNff>
<codTns>String</codTns>
<codSnf>String</codSnf>
<datEmi>String</datEmi>
<codCli>Integer</codCli>
<perCom>Integer</perCom>
<codCpg>String</codCpg>
<codFpg>Integer</codFpg>
<codPor>String</codPor>
<codCrt>String</codCrt>
<perMul>Integer</perMul>
<tolMul>Integer</tolMul>
<perJrs>Integer</perJrs>
<jrsSpl>String</jrsSpl>
<tolJrs>Integer</tolJrs>
<vlrOut>Double</vlrOut>
<cnpjFilial>String</cnpjFilial>
<cnpjCliente>String</cnpjCliente>
<numInt>String</numInt>
<composicao>
<codEmp>Integer</codEmp>
<filNfv>Integer</filNfv>
<snfNfv>String</snfNfv>
<nfvNfv>Integer</nfvNfv>
</composicao>
<parcelas>
<vctPar>String</vctPar>
<vlrPar>Double</vlrPar>
<perDsc>Integer</perDsc>
<qtdDdd>Integer</qtdDdd>
</parcelas>
</fatura>
<transacaoBaixa>String</transacaoBaixa>
<parcelasEspeciais>String</parcelasEspeciais>
<grupoEmpresas>String</grupoEmpresas>
<tipoProcessamento>Integer</tipoProcessamento>
<dataBuild>String</dataBuild>
</parameters>
</ser:GravarFatura>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| opcaoTitulo | Integer | (Opcional) - Number(001) - Indicativo do tratamento para títulos das notas fiscais incluídas nas faturas - Lista: 0 - títulos devem ser excluídos; 1 - títulos devem ser baixados por substituição. |
| fatura | Set | |
| fatura.codEmp | Integer | Condição: opcional quando informado o campo CNPJFilial. |
| fatura.codFil | Integer | Condição: opcional quando informado o campo CNPJFilial. |
| fatura.numNff | Integer | (Obrigatório) - Number(009) - Nr. NF |
| fatura.codTns | String | (Obrigatório) - String(005) - Trans. |
| fatura.codSnf | String | (Obrigatório) - String(003) - Série Fatura |
| fatura.datEmi | DateTime | (Obrigatório) - Date(000) - Data Emissão |
| fatura.codCli | Integer | Condição: opcional quando informado o campo CNPJCliente. |
| fatura.perCom | Integer | (Opcional) - Number(005) - % Comiss. |
| fatura.codCpg | String | (Obrigatório) - String(006) - Cond. Pgto. |
| fatura.codFpg | Integer | (Opcional) - Number(002) - Forma Pgto. |
| fatura.codPor | String | (Obrigatório) - String(004) - Port. |
| fatura.codCrt | String | (Obrigatório) - String(002) - Cart. |
| fatura.perMul | Integer | (Opcional) - Number(005) - % Multa |
| fatura.tolMul | Integer | (Opcional) - Number(003) - Dias Tol. Multa |
| fatura.perJrs | Integer | (Opcional) - Number(005) - % Jrs. |
| fatura.jrsSpl | String | (Opcional) - String(001) - Tipo - Lista: S = Juros Simples, C = Juros Compostos |
| fatura.tolJrs | Integer | (Opcional) - Number(003) - Dias Tol. Jrs. |
| fatura.vlrOut | Double | (Opcional) - Number(015) - Vlr. Outras |
| fatura.cnpjFilial | String | (Opcional) - Number(014) - CNPJ da Filial para Emissão da Fatura. Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos. - Condição: Será retornado caso seja informado na geração da fatura. Obrigatório quando não informados os campos CodEmp e CodFil |
| fatura.cnpjCliente | String | (Opcional) - Number(014) - CPF/CNPJ do Cliente para Emissão da Fatura - Condição: obrigatório quando não informado o campo CodCli. |
| fatura.numInt | String | (Opcional) - String(020) - Número da fatura de sistemas terceiros. Condição: obrigatório quando o campo NumNff não for informado. |
| fatura.composicao | Set | |
| fatura.composicao.codEmp | Integer | (Obrigatório) - Number(004) - Empresa |
| fatura.composicao.filNfv | Integer | (Obrigatório) - Number(005) - Filial NFS |
| fatura.composicao.snfNfv | String | (Obrigatório) - String(003) - Série NFS |
| fatura.composicao.nfvNfv | Integer | (Obrigatório) - Number(009) - Nº NFS |
| fatura.parcelas | Set | |
| fatura.parcelas.vctPar | DateTime | (Obrigatório) - Date(000) - Data Venc. |
| fatura.parcelas.vlrPar | Double | (Obrigatório) - Number(015) - Valor |
| fatura.parcelas.perDsc | Integer | (Opcional) - Number(005) - % Desc. |
| fatura.parcelas.qtdDdd | Integer | (Opcional) - Number(003) - Dias Tol. |
| transacaoBaixa | String | (Opcional) - String(005) - Código da transação para efetuar a baixa dos títulos por substituição - Condição: obrigatório quando o parâmetro OpcaoTítulos possuir valor 1. |
| parcelasEspeciais | String | (Opcional) - String(001) - Indica que as parcelas especiais dos pedidos vinculados a nota fiscal de saída devem ser consideradas. Lista: N - Não; S - Sim. Condição: quando não informado, o valor padrão será N - Não. |
| grupoEmpresas | String | (Opcional) - String(001) - Indica se as notas fiscais de saída de clientes do mesmo grupo de empresas devem ser agrupadas na mesma fatura. Lista: N - Não; S - Sim. Condição: quando não informado, o valor padrão será N - Não. |
| tipoProcessamento | Integer | (Opcional) - Number(001) - Indicativo de tipo de processamento de faturas - Lista: 0 - Incluir fatura; 1 - Excluir faturas, reabilitando títulos. |
| dataBuild | String | Mantido por compatibilidade. |
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:GravarFaturaResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<retornoFaturas>
<codEmp>String</codEmp>
<codFil>String</codFil>
<cnpjFilial>String</cnpjFilial>
<codSnf>String</codSnf>
<codTns>String</codTns>
<numNff>String</numNff>
<numInt>String</numInt>
<retorno>String</retorno>
</retornoFaturas>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:GravarFaturaResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descriçã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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| retornoFaturas | Set | |
| retornoFaturas.codEmp | String | (Obrigatório) - Number(004) - Código da Empresa de Emissão da Fatura |
| retornoFaturas.codFil | String | (Obrigatório) - Number(005) - Código da Filial pertencente a Empresa de Emissão da Fatura |
| retornoFaturas.cnpjFilial | String | (Opcional) - Number(014) - CNPJ da Filial de Emissão da Fatura - Condição: Será retornado caso seja informado na geração da fatura. |
| retornoFaturas.codSnf | String | (Obrigatório) - String(003) - Código da Série da Fatura |
| retornoFaturas.codTns | String | (Obrigatório) - String(005) - Transação da fatura. |
| retornoFaturas.numNff | String | (Obrigatório) - Number(009) - Nr. NF |
| retornoFaturas.numInt | String | (Opcional) - String(020) - Número da fatura de sistemas terceiros. Condição: obrigatório quando o campo NumNff não for informado. |
| retornoFaturas.retorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno da Gravação da Fatura - Lista: OK = Processo Executado com Sucesso, Mensagem = Mensagem do problema ocorrido |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
English
Español
