IN CadastroContratos.integrador: mudanças entre as edições

De CIGAM WIKI
Criou página com '{{VoltarPagina}} *<b>Requisição</b> **<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx **<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/m...'
 
Sem resumo de edição
 
(4 revisões intermediárias pela mesma usuária não estão sendo mostradas)
Linha 1: Linha 1:
{{VoltarPagina}}
{{VoltarPagina}}
[[Integrador]] >
[[IN_CIGAM Integrador#Financeiro|WebServices]] >
[[IN CadastroContratos.integrador]]


*<b>Requisição</b>
=Requisição=
**<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx
*<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx
**<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo
*<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo
**<b>Tipo de registro:</b> <u>CCONTR</u></br>
**<b>Tipo de registro:</b> CCONTR</br>


== CadastrarContratos ==
=Métodos=
<p align=“justify”><i>Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.</i></p>
<!--bgcolor="#5F6B7A"-->
 
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
*<b>Parâmetros:</b><br>
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>CadastrarContratos</b></font></td>
    </tr>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 30: Linha 38:
}}
}}


*<b>Distribuição das Tags XML:</b><br>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*<cadastroContrato>
*<cadastroContrato>
**<contratos>
**<contratos>
***<contrato>
***<contrato>
****<descricao>CONTRATO INT1</descricao>
****<descricao>CONTRATO INT1</descricao>
****<natureza>C</natureza>
****<natureza>C</natureza>
****<tipo>1</tipo>
****<tipo>1</tipo>
****<codigoObjeto>COBRAN</codigoObjeto>
****<codigoObjeto>COBRAN</codigoObjeto>
****<objeto>XXX</objeto>
****<objeto>XXX</objeto>
****<codigoContratante>00010</codigoContratante>
****<codigoContratante>00010</codigoContratante>
****<codigoCobranca>00010</codigoCobranca>
****<codigoCobranca>00010</codigoCobranca>
****<codigoCliente>00010</codigoCliente>
****<codigoCliente>00010</codigoCliente>
****<contato>Paulo</contato>
****<contato>Paulo</contato>
****<dataInicio>2016-07-28 00:00:00.000</dataInicio>
****<dataInicio>2016-07-28 00:00:00.000</dataInicio>
****<dataTermino>2016-07-28 00:00:00.000</dataTermino>
****<dataTermino>2016-07-28 00:00:00.000</dataTermino>
****<diaVencimento>10</diaVencimento>
****<diaVencimento>10</diaVencimento>
****<renovacao>1</renovacao>
****<renovacao>1</renovacao>
****<codigoUnidadeDeNegocio>1</codigoUnidadeDeNegocio>
****<codigoUnidadeDeNegocio>1</codigoUnidadeDeNegocio>
****<periodicidade>1</periodicidade>
****<periodicidade>1</periodicidade>
****<dataBase>2016-07-28 00:00:00.000</dataBase>
****<dataBase>2016-07-28 00:00:00.000</dataBase>
****<valorParcela>10045</valorParcela>
****<valorParcela>10045</valorParcela>
****<situacaoContrato>A</situacaoContrato>
****<situacaoContrato>A</situacaoContrato>
****<dataCancelamento>2012-08-27 00:00:00.000</dataCancelamento>
****<dataCancelamento>2012-08-27 00:00:00.000</dataCancelamento>
****<observacao>Doação, este contrato está sempre ativo e não é faturado.</observacao>
****<observacao>Doação, este contrato está sempre ativo e não é faturado.</observacao>
****<modalidade>R</modalidade>
****<modalidade>R</modalidade>
****<diasVencimentoFaturamento>0</diasVencimentoFaturamento>
****<diasVencimentoFaturamento>0</diasVencimentoFaturamento>
****<deslocamento>0</deslocamento>
****<deslocamento>0</deslocamento>
****<diaBase>0</diaBase>
****<diaBase>0</diaBase>
****<codigoConta>010104</codigoConta>
****<codigoConta>010104</codigoConta>
****<jurosMesPercentual>0</jurosMesPercentual>
****<jurosMesPercentual>0</jurosMesPercentual>
****<jurosDeMora>0</jurosDeMora>
****<jurosDeMora>0</jurosDeMora>
****<percentualMulta>0</percentualMulta>
****<percentualMulta>0</percentualMulta>
****<limiteMultaDias>0</limiteMultaDias>
****<limiteMultaDias>0</limiteMultaDias>
****<juros>1</juros>
****<juros>1</juros>
****<historico>001</historico>
****<historico>001</historico>
****<indiceSomenteReajuste>1</indiceSomenteReajuste>
****<indiceSomenteReajuste>1</indiceSomenteReajuste>
****<adiantarRetornoCobranca>1</adiantarRetornoCobranca>
****<adiantarRetornoCobranca>1</adiantarRetornoCobranca>
****<periodicidadeDeAtendimento>0</periodicidadeDeAtendimento>
****<periodicidadeDeAtendimento>0</periodicidadeDeAtendimento>
****<contratoAssinado>1</contratoAssinado>
****<contratoAssinado>1</contratoAssinado>
****<serieNF/>
****<serieNF/>
****<codigoTipoDePagamento>01</codigoTipoDePagamento>
****<codigoTipoDePagamento>01</codigoTipoDePagamento>
****<codigoAvalista1>00015</codigoAvalista1>
****<codigoAvalista1>00015</codigoAvalista1>
****<codigoAvalista2>00015</codigoAvalista2>
****<codigoAvalista2>00015</codigoAvalista2>
****<codigoFiador>00015</codigoFiador>
****<codigoFiador>00015</codigoFiador>
****<portadorPrevisao>010</portadorPrevisao>
****<portadorPrevisao>010</portadorPrevisao>
****<portadorCobranca>010</portadorCobranca>
****<portadorCobranca>010</portadorCobranca>
****<indice/>
****<indice/>
****<responsavel>XXXXX</responsavel>
****<responsavel>XXXXX</responsavel>
****<limiteRenovacao>2018-12-30 00:00:00.000</limiteRenovacao>
****<limiteRenovacao>2018-12-30 00:00:00.000</limiteRenovacao>
****<parcelaContrato>
****<parcelaContrato>
*****<tipoOperacao>51101</tipoOperacao>
*****<tipoOperacao>51101</tipoOperacao>
*****<portador>00</portador>
*****<portador>00</portador>
*****<parcelasGerar>7</parcelasGerar>
*****<parcelasGerar>7</parcelasGerar>
*****<percentualDescontoVencimento>1.23</percentualDescontoVencimento>
*****<percentualDescontoVencimento>1.23</percentualDescontoVencimento>
*****<venctoPrimeiroLanc>2016-08-10 00:00:00.000</venctoPrimeiroLanc>
*****<venctoPrimeiroLanc>2016-08-10 00:00:00.000</venctoPrimeiroLanc>
*****<dataPrimeiroLancGerar>2016-07-30 00:00:00.000</dataPrimeiroLancGerar>
*****<dataPrimeiroLancGerar>2016-07-30 00:00:00.000</dataPrimeiroLancGerar>
*****<contabilizarRetencao>1</contabilizarRetencao>
*****<contabilizarRetencao>1</contabilizarRetencao>
*****<codigoDarfRetencao>0</codigoDarfRetencao>
*****<codigoDarfRetencao>0</codigoDarfRetencao>
*****<codigoHistoricoRetencao>001</codigoHistoricoRetencao>
*****<codigoHistoricoRetencao>001</codigoHistoricoRetencao>
*****<codigoContaRetencao>010104</codigoContaRetencao>
*****<codigoContaRetencao>010104</codigoContaRetencao>
*****<codigoPortadorRetencao>010</codigoPortadorRetencao>
*****<codigoPortadorRetencao>010</codigoPortadorRetencao>
*****<indice/>
*****<indice/>
****</parcelaContrato>
****</parcelaContrato>
****<parcelasPadrao>
****<parcelasPadrao>
*****<parcelaPadrao>
*****<parcelaPadrao>
******<sequenciaParcela>1</sequenciaParcela>
******<sequenciaParcela>1</sequenciaParcela>
******<codigoMaterial>30001000047</codigoMaterial>
******<codigoMaterial>30001000047</codigoMaterial>
******<repeticao>0</repeticao>
******<repeticao>0</repeticao>
******<periodicidade>1</periodicidade>
******<periodicidade>1</periodicidade>
******<quantidade>50</quantidade>
******<quantidade>50</quantidade>
******<tipoOperacao>6102c</tipoOperacao>
******<tipoOperacao>6102c</tipoOperacao>
******<precoUnitario>50.00</precoUnitario>
******<precoUnitario>50.00</precoUnitario>
******<valorDesconto>2.55</valorDesconto>
******<valorDesconto>2.55</valorDesconto>
******<descricao>0x040030303030</descricao>
******<descricao>0x040030303030</descricao>
******<dataCompetencia>2016-05-03 00:00:00.000</dataCompetencia>
******<dataCompetencia>2016-05-03 00:00:00.000</dataCompetencia>
******<quantidadeOriginal>0</quantidadeOriginal>
******<quantidadeOriginal>0</quantidadeOriginal>
******<percentualISS>0</percentualISS>
******<percentualISS>0</percentualISS>
******<dataInicioParcela>2016-05-03 00:00:00.000</dataInicioParcela>
******<dataInicioParcela>2016-05-03 00:00:00.000</dataInicioParcela>
******<datafimParcela>2016-05-03 00:00:00.000</datafimParcela>
******<datafimParcela>2016-05-03 00:00:00.000</datafimParcela>
******<documentoInicio>Documento</documentoInicio>
******<documentoInicio>Documento</documentoInicio>
******<numeroParcela>1</numeroParcela>
******<numeroParcela>1</numeroParcela>
******<reduzidoGerencial>0</reduzidoGerencial>
******<reduzidoGerencial>0</reduzidoGerencial>
*****</parcelaPadrao>
*****</parcelaPadrao>
****</parcelasPadrao>
****</parcelasPadrao>
***</contrato>
***</contrato>
**</contratos>
**</contratos>
*</cadastroContrato>
*</cadastroContrato>
}}
}}


*<b>Distribuição das Tags Json:</b><br>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*{
*{
**"contratos": [{
**"contratos": [{
****"descricao": "CONTRATO DE PERMUTA",
****"descricao": "CONTRATO DE PERMUTA",
****"natureza": "P",
****"natureza": "P",
****"tipo": "1",
****"tipo": "1",
****"codigoObjeto": "COBRAN",
****"codigoObjeto": "COBRAN",
****"objeto": "COBRANÇA",
****"objeto": "COBRANÇA",
****"codigoContratante": "00002",
****"codigoContratante": "00002",
****"codigoCobranca": "ATRAS",
****"codigoCobranca": "ATRAS",
****"codigoCliente": "00002",
****"codigoCliente": "00002",
****"contato": "XXXXXX",
****"contato": "XXXXXX",
****"dataInicio": "2016-08-08 00:00:00.000",
****"dataInicio": "2016-08-08 00:00:00.000",
****"dataTermino": "2016-08-08 00:00:00.000",
****"dataTermino": "2016-08-08 00:00:00.000",
****"diaVencimento": "1",
****"diaVencimento": "1",
****"renovacao": "1",
****"renovacao": "1",
****"codigoUnidadeDeNegocio": "1",
****"codigoUnidadeDeNegocio": "1",
****"periodicidade": "1",
****"periodicidade": "1",
****"dataBase": "2016-07-29 00:00:00.000",
****"dataBase": "2016-07-29 00:00:00.000",
****"valorParcela": "47.45",
****"valorParcela": "47.45",
****"situacaoContrato": "A",
****"situacaoContrato": "A",
****"dataCancelamento": "2012-01-17 00:00:00.000",
****"dataCancelamento": "2012-01-17 00:00:00.000",
****"observacao": "Doação, este contrato está sempre ativo e não é faturado.",
****"observacao": "Doação, este contrato está sempre ativo e não é faturado.",
****"modalidade": "A",
****"modalidade": "A",
****"diasVencimentoFaturamento": "0",
****"diasVencimentoFaturamento": "0",
****"deslocamento": "0",
****"deslocamento": "0",
****"diaBase": "1",
****"diaBase": "1",
****"codigoConta": "020309",
****"codigoConta": "020309",
****"jurosMesPercentual": "0",
****"jurosMesPercentual": "0",
****"jurosDeMora": "0",
****"jurosDeMora": "0",
****"percentualMulta": "0",
****"percentualMulta": "0",
****"limiteMultaDias": "0",
****"limiteMultaDias": "0",
****"juros": "1",
****"juros": "1",
****"historico": "676",
****"historico": "676",
****"indiceSomenteReajuste": "1",
****"indiceSomenteReajuste": "1",
****"adiantarRetornoCobranca": "1",
****"adiantarRetornoCobranca": "1",
****"periodicidadeDeAtendimento": "0",
****"periodicidadeDeAtendimento": "0",
****"contratoAssinado": "1",
****"contratoAssinado": "1",
****"serieNF": "ENTRA",
****"serieNF": "ENTRA",
****"codigoTipoDePagamento": "01",
****"codigoTipoDePagamento": "01",
****"codigoAvalista1": "00009",
****"codigoAvalista1": "00009",
****"codigoAvalista2": "00008",
****"codigoAvalista2": "00008",
****"codigoFiador": "00011",
****"codigoFiador": "00011",
****"portadorPrevisao": "010",
****"portadorPrevisao": "010",
****"portadorCobranca": "020",
****"portadorCobranca": "020",
****"indice": "ANA",
****"indice": "ANA",
****"responsavel": "00003",
****"responsavel": "00003",
****"limiteRenovacao": "2016-06-17 00:00:00.000",
****"limiteRenovacao": "2016-06-17 00:00:00.000",
****"parcelaContrato": {
****"parcelaContrato": {
*****"tipoOperacao": "1101A",
*****"tipoOperacao": "1101A",
*****"portador": "010",
*****"portador": "010",
*****"parcelasGerar": "24",
*****"parcelasGerar": "24",
*****"percentualDescontoVencimento": "1.23",
*****"percentualDescontoVencimento": "1.23",
*****"venctoPrimeiroLanc": "2016-08-29 00:00:00.000",
*****"venctoPrimeiroLanc": "2016-08-29 00:00:00.000",
*****"dataPrimeiroLancGerar": "2016-08-29 00:00:00.000",
*****"dataPrimeiroLancGerar": "2016-08-29 00:00:00.000",
*****"contabilizarRetencao": "1",
*****"contabilizarRetencao": "1",
*****"codigoHistoricoRetencao": "676",
*****"codigoHistoricoRetencao": "676",
*****"codigoPortadorRetencao": "010",
*****"codigoPortadorRetencao": "010",
*****"indice": "US"
*****"indice": "US"
****},
****},
****"parcelasPadrao": [{
****"parcelasPadrao": [{
*****"sequenciaParcela": "1",
*****"sequenciaParcela": "1",
*****"codigoMaterial": "000011",
*****"codigoMaterial": "000011",
*****"repeticao": "0",
*****"repeticao": "0",
*****"periodicidade": "1",
*****"periodicidade": "1",
*****"quantidade": "50",
*****"quantidade": "50",
*****"tipoOperacao": "1101A",
*****"tipoOperacao": "1101A",
*****"valorDesconto": "0",
*****"valorDesconto": "0",
*****"descricao": "0x040030303030",
*****"descricao": "0x040030303030",
*****"dataCompetencia": "2016-07-29 00:00:00.000",
*****"dataCompetencia": "2016-07-29 00:00:00.000",
*****"quantidadeOriginal": "50",
*****"quantidadeOriginal": "50",
*****"percentualISS": "0",
*****"percentualISS": "0",
*****"dataInicioParcela": "2016-07-29 00:00:00.000",
*****"dataInicioParcela": "2016-07-29 00:00:00.000",
*****"precoUnitario": "9999.99",
*****"precoUnitario": "9999.99",
*****"datafimParcela": "2016-07-29 00:00:00.000",
*****"datafimParcela": "2016-07-29 00:00:00.000",
*****"documentoInicio": "teste",
*****"documentoInicio": "teste",
*****"numeroParcela": "0",
*****"numeroParcela": "0",
*****"reduzidoGerencial": "506"
*****"reduzidoGerencial": "506"
****}]
****}]
***}
***}
**]
**]
*}
*}
}}
}}


<b>Retorno:</b><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exemplo de retorno SOAP:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
*<retorno>
{{#tree: minExpandLevel=2 |
***<mensagem>sucesso</mensagem>
*<retorno>
****<detalhes>
**<mensagem>sucesso</mensagem>
*****<registro>
***<detalhes>
******<id>1149</id>
****<registro>
*****</registro>
*****<id>1149</id>
****</detalhes>
****</registro>
*</retorno>
***</detalhes>
<br>
*</retorno>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exemplo de retorno REST:<br/>
}}
*{
 
**"mensagem": "sucesso",
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
**"detalhes": [{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
***"registro": {
{{#tree: minExpandLevel=2 |
****"id": "1149"
*{
***}
**"mensagem": "sucesso",
**}]
**"detalhes": [{
*}
***"registro": {
****"id": "1149"
***}
**}]
*}
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
Linha 233: Linha 246:
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


 
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
== LiberarPendentes ==
    <tr>
<p align=“justify”><i>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>LiberarPendentes</b></font></td>
</i></p>
    </tr>
 
    <tr>
*<b>Parâmetros:</b><br>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 248: Linha 264:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
Linha 257: Linha 273:
&nbsp;&nbsp;&nbsp;Se ID inválido ou não encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se ID inválido ou não encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Falha ao liberar registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Falha ao liberar registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarId ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarId</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 268: Linha 288:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 280: Linha 300:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarIndividual ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarIndividual</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 294: Linha 318:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 534: Linha 558:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarContratosCompleto ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarContratosCompleto</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 554: Linha 582:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 160: Linha 1 188:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarModificacoes ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarModificacoes</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 183: Linha 1 215:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 423: Linha 1 455:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarPendentes ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 444: Linha 1 480:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 468: Linha 1 504:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>

Edição atual tal como às 13h52min de 7 de outubro de 2026

Voltar
Integrador > WebServices > IN CadastroContratos.integrador

Requisição

Métodos

CadastrarContratos

Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

Parâmetros:



Distribuição das Tags XML:



Distribuição das Tags Json:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

LiberarPendentes

Parâmetros:



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao liberar registro.

Voltar ao início

ListarId

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarIndividual

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarContratosCompleto

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarModificacoes

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarPendentes

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início