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:
{"minExpandLevel":2} - pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
- contratosXml
- Tipo: String -
- Conteúdo de um arquivo XML com os contratos, parcela Padrão e Parcelas.
- Obrigatório apenas para requisições SOAP.
- contratosJson
- Tipo: String -
- Conteúdo de um arquivo JSON com os contratos, parcela padrão e Parcelas.
- Obrigatório apenas para requisições REST/JSON.
Distribuição das Tags XML:
{"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>
Distribuição das Tags Json:
{"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"
- }]
- }
- ]
- }
Retornos:
Se sucesso:
* Exemplo de retorno SOAP:
{"minExpandLevel":2} - <retorno>
- <mensagem>sucesso</mensagem>
- </retorno>
* Exemplo de retorno REST:
{"minExpandLevel":2} - {
- "mensagem": "sucesso",
- "detalhes": [{
- }]
- }
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 |