Cliente | Referências bancárias
Este artigo documenta o processo para inserir, editar e deletar uma referência bancária de um cliente.
Recurso responsável pelas informações das referencias bancárias de um cliente.
Inserir referência bancária
Insere uma referência bancária de um cliente.
| Requisição |
|
| Método |
POST |
| URL |
/api/v1/clientes/{id}/referencias_bancarias |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_bancarias |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
banco |
String |
60 |
Sim |
Nome d banco |
agencia |
String |
10 |
Não |
Agência |
conta |
String |
10 |
Não |
Número da conta |
telefone |
String |
20 |
Sim |
Telefone |
contato |
String |
30 |
Não |
Nome para contato |
clienteDesde |
Date |
- |
Não |
Cliente desde no formato AAAA-MM-DD |
observacao |
String |
200 |
Não |
Observação |
{
"banco": "Banco C6",
"agencia": "10",
"conta": "1000",
"telefone": "(49) 0000-0000",
"contato": "Gerente",
"clienteDesde": "2020-10-01",
"observacao": "Observações"
}
Resposta
A API retornará o código identificador da referência bancária inserida.
Estrutura de dados do resposta
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
id |
Integer |
- |
Sim |
Código identificador da referência bancária |
Exemplo de resposta
{
"id": 1
}
Editar referência bancária
Atualiza uma referência bancária de um cliente.
| Requisição |
|
| Método |
PUT |
| URL |
/api/v1/clientes/{id}/referencias_bancarias/{referenciaBancariaId} |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
referenciaBancariaId |
Código identificador da referência bancária |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_bancarias/1 |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
banco |
String |
60 |
Sim |
Nome d banco |
agencia |
String |
10 |
Não |
Agência |
conta |
String |
10 |
Não |
Número da conta |
telefone |
String |
20 |
Sim |
Telefone |
contato |
String |
30 |
Não |
Nome para contato |
clienteDesde |
Date |
- |
Não |
Cliente desde no formato AAAA-MM-DD |
observacao |
String |
200 |
Não |
Observação |
{
"banco": "Banco C6",
"agencia": "10",
"conta": "1000",
"telefone": "(49) 0000-0000",
"contato": "Gerente",
"clienteDesde": "2020-10-01",
"observacao": "Observações - alterado"
}
Excluir referência bancária
Exclui uma referência bancária de um cliente.
| Requisição |
|
| Método |
DELETE |
| URL |
/api/v1/clientes/{id}/referencias_bancarias/{referenciaBancariaId} |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
referenciaBancariaId |
Código identificador da referência bancária |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_bancarias/1 |
