Suspensão temporária de contrato
O objetivo deste serviço é realizar a inclusão de uma suspensão temporária para um contrato. Abaixo, segue exemplo do json de envio:
{
"contract_suspend_temporary":
{
"customer_id": 5248,
"contract_id": 6254,
"duration": 30,
"start_date": "2020-08-03",
"user": "silvana",
"ticket_id": 3265
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | contract_suspend_temporary |
Sim | Raiz | - | |
A02 | customer_id |
Sim | A01 | Número |
Código do cliente. Aceita valores inteiros positivos e maiores que zero. |
A03 | contract_id |
Sim | A01 | Número |
Número do contrato do cliente que será suspenso. Aceita valores inteiros positivos e maiores que zero. É necessário informar um contrato na situação Ativo. |
A04 | duration |
Sim | A01 | Número |
Duração, em dias, da suspensão temporária. Aceita valores inteiros positivos e maiores que zero. |
A05 | start_date |
Sim | A01 | Data |
Data inicial da suspensão no formato AAAA-MM-DD. Aceita valores maiores ou iguais à data atual. Informando a data atual o contrato será suspenso imediatamente. |
A06 | user |
Não | A01 | Texto |
Usuário responsável pelo registro da suspensão. Deve ser um usuário cadastrado no sistema e com a situação Ativo. Ao não informar este campo o registro da suspensão será realizado com o usuário configurado no cadastro do webservice. |
A07 | ticket_id |
Não | A01 | Número |
Número do atendimento ao qual a suspensão está vinculada. |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": "The contract will be suspended on the date informed"
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 19,
"error_description": "Unknown error!",
"result": ""
}