Cadastro de pré-faturamento

De RBX ISP - Manual do Usuário

O objetivo deste serviço é possibilitar o cadastro de um pré-faturamento. Abaixo, segue exemplo do json de envio:

{
  "pre_billing_insert":
  {
    "customer_id": 2563,
    "contract_id": 26552,
    "period": "201905",
    "type": "increase",
    "description": "Adicional",
    "value": 100.20
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 Dados pré-faturamento Sim Raiz -  
A02 customer_id Sim A01 Número

Código do cliente

A03 contract_id Sim A01 Número

Número do contrato

A04 period Não A01 Texto

Período do pré-faturamento no padrão "AAAAMM".

  • O ano deve ser maior que 2000 e informado com 4 dígitos.
  • O mês deve ser informado com 2 dígitos.
A05 type Sim A01 Texto

Tipo do pré-faturamentos. Valores permitidos:

  • discount (desconto)
  • increase (acréscimo)
  • telephony (telefonia)
  • fine (multa)
  • interest (juros)
A06 description Sim A01 Texto

Descrição do pré-faturamento

A07 value Sim A01 Decimal (15.2)

Valor do pré-faturamento. O valor deve ser maior que zero.

 

Mensagem de retorno

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

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result":
    {
       "id": "15487",
       "comments":"texto livre"
    }
}

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

{
  "status": 0,
  "error_code": 12,
  "error_description": "Document not found!",
  "result": ""
}