Consulta documentos em aberto de clientes
De RBX ISP - Manual do Usuário
O objetivo deste serviço é retornar todos os documentos em aberto de um cliente que estejam lançados em determinada conta no sistema. Abaixo, seguem exemplos do json de envio:
{
"get_unpaid_document":
{
"customer_id": 22563,
"account_number": 3
}
}
{
"get_unpaid_document":
{
"customer_id": 22563,
"account_list": [3,6,9]
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados da autenticação | Sim | Raiz | - | |
A02 | customer_id |
Sim | A01 | Número |
Código do cliente |
A03 | account_number |
Sim* | A01 | Número |
Número da conta corrente onde será realizada a consulta. Atenção: é permitido informar apenas um dos campos: account_number ou account_list. |
A04 | account_list |
Sim* | A01 | Lista |
Lista contendo todos os números de conta para realização da consulta. Atenção: é permitido informar apenas um dos campos: account_number ou account_list. |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result":
{
"id": 11278864,
"account_number": 3,
"due_date": "2019-01-10",
"document_number": 10005798,
"bank_number": 598,
"historic": "Documento a Receber",
"comments": "Boleto de Adesão",
"source": "Adhesion",
"bank": 1,
"value_init": 50,
"value_interest": 7.3,
"value_fine": 0.5,
"value_discount": 0,
"value_up": 57.8,
"address":
{
"street": "Rua Presidente Nereu Ramos",
"number": 102,
"complement": "",
"neighborhood": "Centro",
"city": "Marialva",
"state": "PR",
"district": "",
"zipcode": "86990000",
"country": "Brasil"
}
},
{
"id": 11278865,
"account_number": 3,
"due_date": "2019-02-10",
"document_number": 10005799,
"bank_number": 599,
"historic": "Documento a Receber",
"comments": "Boleto de Adesão",
"source": "Adhesion",
"bank": 1,
"value_init": 50,
"value_interest": 6.68,
"value_fine": 0.5,
"value_discount": 0,
"value_up": 57.18,
"address":
{
"street": "Rua Presidente Nereu Ramos",
"number": 102,
"complement": "",
"neighborhood": "Centro",
"city": "Marialva",
"state": "PR",
"district": "",
"zipcode": "86990000",
"country": "Brasil"
}
}
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 12,
"error_description": "The field customer_id is required!",
"result": ""
}