Felipe: Criou página com '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 env...'

2021-06-04T12:08:05Z

Criou página com '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 env...'

Página nova

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:
<syntaxhighlight lang="json" line="1">
{
"get_unpaid_document":
{
"customer_id": 22563,
"account_number": 3
}
}
</syntaxhighlight>
<syntaxhighlight lang="json" line="1">
{
"get_unpaid_document":
{
"customer_id": 22563,
"account_list": [3,6,9]
}
}
</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 da autenticação</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;"><code>customer_id</code></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 do cliente
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 4.11634%; height: 18px;"><code>account_number</code></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;">
Número da conta corrente onde será realizada a consulta. Atenção: é permitido informar apenas um dos campos: account_number ou account_list.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 4.11634%; height: 18px;"><code>account_list</code></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;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
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.
</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":
{
"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"
}
}
}
</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": "The field customer_id is required!",
"result": ""
}
</syntaxhighlight>

Consulta documentos em aberto de clientes - Histórico de revisão

Felipe: Criou página com '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 env...'