Felipe em 11h13min de 4 de junho de 2021

2021-06-04T11:13:56Z

Felipe em 11h13min de 4 de junho de 2021

2021-06-04T11:13:43Z

Felipe: Criou página com 'O objetivo deste serviço é realizar o cancelamento de um contrato. Abaixo, segue exemplo do json de envio: { "contract_cancel": {...'

2021-06-04T11:13:17Z

Criou página com 'O objetivo deste serviço é realizar o cancelamento de um contrato. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "contract_cancel": {...'

Página nova

O objetivo deste serviço é realizar o cancelamento de um contrato. Abaixo, segue exemplo do json de envio:

<syntaxhighlight lang="json" line="1">
{
"contract_cancel":
{
"customer_id": 4777,
"contract_id": 788570,
"reason_id": 1,
"cancel_competition_id": 1,
"billing":
{
"future_cancel": true,
"cancellation_period_action": "block",
"reason_id": 3
},
"pre_billing":
{
"cancel": true,
"cancellation_period_action": "cancel"
},
"fine":
{
"account_id": 3,
"historic_id": 1
},
"os":
{
"open": 3,
"target_type": 1,
"target_id": 1
}
}
}
</syntaxhighlight>

'''Detalhamento dos campos'''
<table style="border-collapse: collapse; width: 100%;" border="1">
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">ID</td>
<td style="width: 6.5821%; height: 18px;">Campo</td>
<td style="width: 3.62012%; height: 18px;">Obrigatório</td>
<td style="width: 0.728833%; height: 18px;">Pai</td>
<td style="width: 1.01088%; height: 18px;">Tipo</td>
<td style="width: 38.4579%; height: 18px;">Observações</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 6.5821%; height: 18px;">contract_cancel</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">Raiz</td>
<td style="width: 1.01088%; height: 18px;">-</td>
<td style="width: 38.4579%; height: 18px;"> </td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 6.5821%; height: 18px;">customer_id</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Número</td>
<td style="width: 38.4579%; height: 18px;">
Código do cliente. Aceita valores inteiros positivos e maiores que zero.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 6.5821%; height: 18px;">contract_id</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Número</td>
<td style="width: 38.4579%; height: 18px;">
Número do contrato que será cancelado. Aceita valores inteiros positivos e maiores que zero. Para que um contrato possa ser cancelado ele deve estar em uma das situações a seguir:
<ul>
<li>Aguardando Instalação</li>
<li>Em Instalação</li>
<li>Ativo</li>
<li>Bloqueado</li>
<li>Suspenso</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 6.5821%; height: 18px;">reason_id</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Número</td>
<td style="width: 38.4579%; height: 18px;">
Código do motivo de cancelamento. Aceita valores inteiros positivos e maiores que zero.
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A05</td>
<td style="width: 6.5821%;">cancel_competition_id</td>
<td style="width: 3.62012%;">Não</td>
<td style="width: 0.728833%;">A01</td>
<td style="width: 1.01088%;">Número</td>
<td style="width: 38.4579%;">
Código da concorrência de cancelamento. Aceita valores inteiros positivos e maiores que zero.
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A06</td>
<td style="width: 6.5821%;">billing</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A01</td>
<td style="width: 1.01088%;">-</td>
<td style="width: 38.4579%;">
Grupo de informações para estorno de faturamento
</td>
</tr>
<tr>
<td style="width: 2.56232%;">B01</td>
<td style="width: 6.5821%;">future_cancel</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A06</td>
<td style="width: 1.01088%;">Booleano</td>
<td style="width: 38.4579%;">
Informa se os faturamentos futuros deverão ser cancelados.
<ul>
<li>true: estorna os faturamentos futuros</li>
<li>false: não estorna os faturamentos futuros</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">B02</td>
<td style="width: 6.5821%;">cancellation_period_action</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A06</td>
<td style="width: 1.01088%;">Texto</td>
<td style="width: 38.4579%;">
Define qual ação deverá ser realizada para o faturamento referente ao período de cancelamento:
<ul>
<li>none: nenhuma ação</li>
<li>cancel: estornar o documento</li>
<li>block: não gerar residual </li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">B03</td>
<td style="width: 6.5821%;">reason_id</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A06</td>
<td style="width: 1.01088%;">Número</td>
<td style="width: 38.4579%;">
Código do motivo de estorno dos documentos financeiros. Aceita valores inteiros positivos e maiores que zero.
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A07</td>
<td style="width: 6.5821%;">pre_billing</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A01</td>
<td style="width: 1.01088%;">-</td>
<td style="width: 38.4579%;">
Grupo de informações para estorno de pré-faturamentos
</td>
</tr>
<tr>
<td style="width: 2.56232%;">C01</td>
<td style="width: 6.5821%;">cancel</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A07</td>
<td style="width: 1.01088%;">Booleano</td>
<td style="width: 38.4579%;">
Informa se os pré-faturamentos deverão ser excluídos.
<ul>
<li>true: estorna os pré-faturamentos</li>
<li>false: não estorna os pré-faturamentos</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">C02</td>
<td style="width: 6.5821%;">cancellation_period_action</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A07</td>
<td style="width: 1.01088%;">Texto</td>
<td style="width: 38.4579%;">
Informa se os pré-faturamentos referentes ao período de cancelamento deverão ser excluídos. Valores permitidos:
<ul>
<li>cancel: estorna os pré-faturamentos</li>
<li>none: não estorna os pré-faturamentos</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A08</td>
<td style="width: 6.5821%;">fine</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A01</td>
<td style="width: 1.01088%;">-</td>
<td style="width: 38.4579%;">
Grupo de informações para geração de multa de cancelamento
</td>
</tr>
<tr>
<td style="width: 2.56232%;">D01</td>
<td style="width: 6.5821%;">account_id</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A08</td>
<td style="width: 1.01088%;">Número</td>
<td style="width: 38.4579%;">
Número da conta corrente para geração do boleto de multa contratual. Aceita valores inteiros positivos e maiores que zero. Deve ser uma conta:
<ul>
<li>De natureza Recebimento.</li>
<li>Que aceita Faturamentos.</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">D02</td>
<td style="width: 6.5821%;">historic_id</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A08</td>
<td style="width: 1.01088%;">Número</td>
<td style="width: 38.4579%;">
Número do histórico para geração do boleto de multa contratual. Aceita valores inteiros positivos e maiores que zero. Deve ser um histórico:
<ul>
<li>De operação Crédito.</li>
<li>Do tipo Prazo.</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A09</td>
<td style="width: 6.5821%;">os</td>
<td style="width: 3.62012%;">Não</td>
<td style="width: 0.728833%;">A01</td>
<td style="width: 1.01088%;">-</td>
<td style="width: 38.4579%;">
Grupo de informações para abertura de atendimento de retirada de equipamentos. Este grupo só é obrigatório se não houver locação transitória cadastrada no sistema.
</td>
</tr>
<tr>
<td style="width: 2.56232%;">E1</td>
<td style="width: 6.5821%;">open</td>
<td style="width: 3.62012%;">Sim</td>
<td style="width: 0.728833%;">A09</td>
<td style="width: 1.01088%;">Booleano</td>
<td style="width: 38.4579%;">
Informa se deverá ser aberto atendimento para retirada de equipamento:
<ul>
<li>true: abrir OS</li>
<li>false: não abrir OS</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">E2</td>
<td style="width: 6.5821%;">target_type</td>
<td style="width: 3.62012%;">Sim*</td>
<td style="width: 0.728833%;">A09</td>
<td style="width: 1.01088%;">Texto</td>
<td style="width: 38.4579%;">
Informe o tipo do alvo para abertura do atendimento. Este campo é obrigatório se no campo A09 foi informado o valor true. Valores permitidos:
<ul>
<li>topic: abrir atendimento em um tópico</li>
<li>workflow: abrir atendimento em um fluxo</li>
</ul>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">E3</td>
<td style="width: 6.5821%;">target_id</td>
<td style="width: 3.62012%;">Sim*</td>
<td style="width: 0.728833%;">A09</td>
<td style="width: 1.01088%;">Número</td>
<td style="width: 38.4579%;">
Informa o código do alvo - tópico ou fluxo, conforme parametrizado no campo A09 - a ser utilizado para abertura do atendimento. Este campo é obrigatório se no campo A09 foi informado o valor true.
</td>
</tr>
</table>
 
'''Mensagem de retorno'''

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": "Successfully cancelled contract"
}
</syntaxhighlight>

Em caso de falha, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 0,
"error_code": 19,
"error_description": "Unknown error!",
"result": ""
}
</syntaxhighlight>

@@ Linha 276: / Linha 276: @@
 <p>&nbsp;</p>
 '''Mensagem de retorno'''
 Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

Cancelamento de contrato - Histórico de revisão

Felipe em 11h13min de 4 de junho de 2021

Felipe em 11h13min de 4 de junho de 2021

Felipe: Criou página com 'O objetivo deste serviço é realizar o cancelamento de um contrato. Abaixo, segue exemplo do json de envio: { "contract_cancel": {...'