Reversão de baixa
De RBX ISP - Manual do Usuário
O objetivo desta serviço é reverter a baixa de um documento financeiro. Abaixo, segue exemplo do json de envio:
{
"document_payment_reversal":
{
"document_id": 32658,
"reason_id": 10,
"user": "maria",
"comments": "baixa indevida"
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados do documento | Sim | Raiz | - | |
A02 | document_id | Sim | A01 | Número |
Código interno do documento no sistema (sequência). Considerações:
|
A03 | reason_id | Não* | A01 | Número |
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. |
A04 | user | Sim | A01 | Texto |
Usuário do sistema responsável pela reversão da baixa. O usuário deve estar ativo. |
A05 | comments | Não | A01 | Texto |
Texto livre para observações. Tamanho máximo permitido: 100 |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result":
[
"Payment successfully reversed"
]
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 12,
"error_description": "Internal Server Error!",
"result": ""
}