Felipe: Criou página com 'O objetivo desta serviço é reverter a baixa de um documento financeiro. Abaixo, segue exemplo do json de envio: { "document_payment...'

2021-06-04T13:22:31Z

Criou página com 'O objetivo desta serviço é reverter a baixa de um documento financeiro. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "document_payment...'

Página nova

O objetivo desta serviço é reverter a baixa de um documento financeiro. Abaixo, segue exemplo do json de envio:

<syntaxhighlight lang="json" line="1">
{
"document_payment_reversal":
{
"document_id": 32658,
"reason_id": 10,
"user": "maria",
"comments": "baixa indevida"
}
}
</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: 4.11634%; height: 18px;">Campo</td>
<td style="width: 0.696864%; height: 18px;">Obrigatório</td>
<td style="width: 0.696864%; height: 18px;">Pai</td>
<td style="width: 3.16901%; height: 18px;">Tipo</td>
<td style="width: 27.3043%; height: 18px;">Observações</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 4.11634%; height: 18px;">Dados do documento</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">Raiz</td>
<td style="width: 3.16901%; height: 18px;">-</td>
<td style="width: 27.3043%; height: 18px;"> </td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 4.11634%; height: 18px;">document_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Código interno do documento no sistema (sequência). Considerações:
<ul>
<li>O documento deve estar baixado.</li>
<li>O documento não pode estar lançado em uma contra transitória.</li>
<li>O documento não pode ter sido pago com cartão.</li>
<li>O documento não pode estar conciliado ou em processo de conciliação bancária.</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 4.11634%; height: 18px;">reason_id</td>
<td style="width: 0.696864%; height: 18px;">Não*</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Código do motivo de estorno cadastrado no sistema.
Conforme regras do sistema, se houver pelo menos um motivo de estorno cadastrado, o mesmo deverá ser informado.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 4.11634%; height: 18px;">user</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Usuário do sistema responsável pela reversão da baixa. O usuário deve estar ativo.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A05</td>
<td style="width: 4.11634%; height: 18px;">comments</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Texto livre para observações.
Tamanho máximo permitido: 100
</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":
[
"Payment successfully reversed"
]
}
</syntaxhighlight>

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

<syntaxhighlight lang="json" line="1">
{
"status": 0,
"error_code": 12,
"error_description": "Internal Server Error!",
"result": ""
}
</syntaxhighlight>

Reversão de baixa - Histórico de revisão

Felipe: Criou página com 'O objetivo desta serviço é reverter a baixa de um documento financeiro. Abaixo, segue exemplo do json de envio: { "document_payment...'