IN CadastroContratos.integrador: mudanças entre as edições
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]] | |||
=Requisição= | |||
*<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx | |||
*<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo | |||
**<b>Tipo de registro:</b | **<b>Tipo de registro:</b> CCONTR</br> | ||
== | =Métodos= | ||
< | <!--bgcolor="#5F6B7A"--> | ||
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | |||
<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: | ||
}} | }} | ||
<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> | |||
**<contratos> | |||
***<contrato> | |||
****<descricao>CONTRATO INT1</descricao> | |||
****<natureza>C</natureza> | |||
****<tipo>1</tipo> | |||
****<codigoObjeto>COBRAN</codigoObjeto> | |||
****<objeto>XXX</objeto> | |||
****<codigoContratante>00010</codigoContratante> | |||
****<codigoCobranca>00010</codigoCobranca> | |||
****<codigoCliente>00010</codigoCliente> | |||
****<contato>Paulo</contato> | |||
****<dataInicio>2016-07-28 00:00:00.000</dataInicio> | |||
****<dataTermino>2016-07-28 00:00:00.000</dataTermino> | |||
****<diaVencimento>10</diaVencimento> | |||
****<renovacao>1</renovacao> | |||
****<codigoUnidadeDeNegocio>1</codigoUnidadeDeNegocio> | |||
****<periodicidade>1</periodicidade> | |||
****<dataBase>2016-07-28 00:00:00.000</dataBase> | |||
****<valorParcela>10045</valorParcela> | |||
****<situacaoContrato>A</situacaoContrato> | |||
****<dataCancelamento>2012-08-27 00:00:00.000</dataCancelamento> | |||
****<observacao>Doação, este contrato está sempre ativo e não é faturado.</observacao> | |||
****<modalidade>R</modalidade> | |||
****<diasVencimentoFaturamento>0</diasVencimentoFaturamento> | |||
****<deslocamento>0</deslocamento> | |||
****<diaBase>0</diaBase> | |||
****<codigoConta>010104</codigoConta> | |||
****<jurosMesPercentual>0</jurosMesPercentual> | |||
****<jurosDeMora>0</jurosDeMora> | |||
****<percentualMulta>0</percentualMulta> | |||
****<limiteMultaDias>0</limiteMultaDias> | |||
****<juros>1</juros> | |||
****<historico>001</historico> | |||
****<indiceSomenteReajuste>1</indiceSomenteReajuste> | |||
****<adiantarRetornoCobranca>1</adiantarRetornoCobranca> | |||
****<periodicidadeDeAtendimento>0</periodicidadeDeAtendimento> | |||
****<contratoAssinado>1</contratoAssinado> | |||
****<serieNF/> | |||
****<codigoTipoDePagamento>01</codigoTipoDePagamento> | |||
****<codigoAvalista1>00015</codigoAvalista1> | |||
****<codigoAvalista2>00015</codigoAvalista2> | |||
****<codigoFiador>00015</codigoFiador> | |||
****<portadorPrevisao>010</portadorPrevisao> | |||
****<portadorCobranca>010</portadorCobranca> | |||
****<indice/> | |||
****<responsavel>XXXXX</responsavel> | |||
****<limiteRenovacao>2018-12-30 00:00:00.000</limiteRenovacao> | |||
****<parcelaContrato> | |||
*****<tipoOperacao>51101</tipoOperacao> | |||
*****<portador>00</portador> | |||
*****<parcelasGerar>7</parcelasGerar> | |||
*****<percentualDescontoVencimento>1.23</percentualDescontoVencimento> | |||
*****<venctoPrimeiroLanc>2016-08-10 00:00:00.000</venctoPrimeiroLanc> | |||
*****<dataPrimeiroLancGerar>2016-07-30 00:00:00.000</dataPrimeiroLancGerar> | |||
*****<contabilizarRetencao>1</contabilizarRetencao> | |||
*****<codigoDarfRetencao>0</codigoDarfRetencao> | |||
*****<codigoHistoricoRetencao>001</codigoHistoricoRetencao> | |||
*****<codigoContaRetencao>010104</codigoContaRetencao> | |||
*****<codigoPortadorRetencao>010</codigoPortadorRetencao> | |||
*****<indice/> | |||
****</parcelaContrato> | |||
****<parcelasPadrao> | |||
*****<parcelaPadrao> | |||
******<sequenciaParcela>1</sequenciaParcela> | |||
******<codigoMaterial>30001000047</codigoMaterial> | |||
******<repeticao>0</repeticao> | |||
******<periodicidade>1</periodicidade> | |||
******<quantidade>50</quantidade> | |||
******<tipoOperacao>6102c</tipoOperacao> | |||
******<precoUnitario>50.00</precoUnitario> | |||
******<valorDesconto>2.55</valorDesconto> | |||
******<descricao>0x040030303030</descricao> | |||
******<dataCompetencia>2016-05-03 00:00:00.000</dataCompetencia> | |||
******<quantidadeOriginal>0</quantidadeOriginal> | |||
******<percentualISS>0</percentualISS> | |||
******<dataInicioParcela>2016-05-03 00:00:00.000</dataInicioParcela> | |||
******<datafimParcela>2016-05-03 00:00:00.000</datafimParcela> | |||
******<documentoInicio>Documento</documentoInicio> | |||
******<numeroParcela>1</numeroParcela> | |||
******<reduzidoGerencial>0</reduzidoGerencial> | |||
*****</parcelaPadrao> | |||
****</parcelasPadrao> | |||
***</contrato> | |||
**</contratos> | |||
*</cadastroContrato> | |||
}} | }} | ||
<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": [{ | |||
****"descricao": "CONTRATO DE PERMUTA", | |||
****"natureza": "P", | |||
****"tipo": "1", | |||
****"codigoObjeto": "COBRAN", | |||
****"objeto": "COBRANÇA", | |||
****"codigoContratante": "00002", | |||
****"codigoCobranca": "ATRAS", | |||
****"codigoCliente": "00002", | |||
****"contato": "XXXXXX", | |||
****"dataInicio": "2016-08-08 00:00:00.000", | |||
****"dataTermino": "2016-08-08 00:00:00.000", | |||
****"diaVencimento": "1", | |||
****"renovacao": "1", | |||
****"codigoUnidadeDeNegocio": "1", | |||
****"periodicidade": "1", | |||
****"dataBase": "2016-07-29 00:00:00.000", | |||
****"valorParcela": "47.45", | |||
****"situacaoContrato": "A", | |||
****"dataCancelamento": "2012-01-17 00:00:00.000", | |||
****"observacao": "Doação, este contrato está sempre ativo e não é faturado.", | |||
****"modalidade": "A", | |||
****"diasVencimentoFaturamento": "0", | |||
****"deslocamento": "0", | |||
****"diaBase": "1", | |||
****"codigoConta": "020309", | |||
****"jurosMesPercentual": "0", | |||
****"jurosDeMora": "0", | |||
****"percentualMulta": "0", | |||
****"limiteMultaDias": "0", | |||
****"juros": "1", | |||
****"historico": "676", | |||
****"indiceSomenteReajuste": "1", | |||
****"adiantarRetornoCobranca": "1", | |||
****"periodicidadeDeAtendimento": "0", | |||
****"contratoAssinado": "1", | |||
****"serieNF": "ENTRA", | |||
****"codigoTipoDePagamento": "01", | |||
****"codigoAvalista1": "00009", | |||
****"codigoAvalista2": "00008", | |||
****"codigoFiador": "00011", | |||
****"portadorPrevisao": "010", | |||
****"portadorCobranca": "020", | |||
****"indice": "ANA", | |||
****"responsavel": "00003", | |||
****"limiteRenovacao": "2016-06-17 00:00:00.000", | |||
****"parcelaContrato": { | |||
*****"tipoOperacao": "1101A", | |||
*****"portador": "010", | |||
*****"parcelasGerar": "24", | |||
*****"percentualDescontoVencimento": "1.23", | |||
*****"venctoPrimeiroLanc": "2016-08-29 00:00:00.000", | |||
*****"dataPrimeiroLancGerar": "2016-08-29 00:00:00.000", | |||
*****"contabilizarRetencao": "1", | |||
*****"codigoHistoricoRetencao": "676", | |||
*****"codigoPortadorRetencao": "010", | |||
*****"indice": "US" | |||
****}, | |||
****"parcelasPadrao": [{ | |||
*****"sequenciaParcela": "1", | |||
*****"codigoMaterial": "000011", | |||
*****"repeticao": "0", | |||
*****"periodicidade": "1", | |||
*****"quantidade": "50", | |||
*****"tipoOperacao": "1101A", | |||
*****"valorDesconto": "0", | |||
*****"descricao": "0x040030303030", | |||
*****"dataCompetencia": "2016-07-29 00:00:00.000", | |||
*****"quantidadeOriginal": "50", | |||
*****"percentualISS": "0", | |||
*****"dataInicioParcela": "2016-07-29 00:00:00.000", | |||
*****"precoUnitario": "9999.99", | |||
*****"datafimParcela": "2016-07-29 00:00:00.000", | |||
*****"documentoInicio": "teste", | |||
*****"numeroParcela": "0", | |||
*****"reduzidoGerencial": "506" | |||
****}] | |||
***} | |||
**] | |||
*} | |||
}} | }} | ||
<b> | <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/> | |||
Se sucesso:<br/> | Se sucesso:<br/> | ||
Exemplo de retorno SOAP:<br/> | * Exemplo de retorno SOAP:<br/> | ||
{{#tree: minExpandLevel=2 | | |||
*<retorno> | |||
**<mensagem>sucesso</mensagem> | |||
***<detalhes> | |||
****<registro> | |||
*****<id>1149</id> | |||
****</registro> | |||
***</detalhes> | |||
<br> | *</retorno> | ||
Exemplo de retorno REST:<br/> | }} | ||
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/> | |||
* Exemplo de retorno REST:<br/> | |||
{{#tree: minExpandLevel=2 | | |||
*{ | |||
**"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: | ||
Se algum parâmetro inválido:<br/> | Se algum parâmetro inválido:<br/> | ||
Parâmetro necessário não informado.</p> | Parâmetro necessário não informado.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | |||
== | <tr> | ||
< | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>LiberarPendentes</b></font></td> | ||
</ | </tr> | ||
<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 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> | <b>Retornos:</b><br/> | ||
Se pin inválido:<br/> | Se pin inválido:<br/> | ||
O usuário não possui direitos suficientes para executar esta rotina.<br/> | O usuário não possui direitos suficientes para executar esta rotina.<br/> | ||
| Linha 257: | Linha 273: | ||
Se ID inválido ou não encontrado:<br/> | Se ID inválido ou não encontrado:<br/> | ||
Falha ao liberar registro.</p> | Falha ao liberar registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarId</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 280: | Linha 300: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarIndividual</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 534: | Linha 558: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarContratosCompleto</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 160: | Linha 1 188: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarModificacoes</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 423: | Linha 1 455: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 468: | Linha 1 504: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | 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
- Soap: http://servidor/CadastroContratos.integrador.asmx
- Rest/JSon: http://servidor/CadastroContratos.integrador.ashx/metodo
- Tipo de registro: CCONTR
- Tipo de registro: CCONTR
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:
|
| LiberarPendentes |
Parâmetros:
|
| ListarId |
Parâmetros:
|
| ListarIndividual |
Parâmetros:
|
| ListarContratosCompleto |
Parâmetros:
|
| ListarModificacoes |
Parâmetros:
|
| ListarPendentes |
Parâmetros:
|
