Cliente | Referências comerciais
Este artigo documenta o processo para inserir, editar e deletar uma referência comercial de um cliente.
Recurso responsável pelas informações das referencias comerciais de um cliente.
Inserir referência comercial
Insere uma referência comercial de um cliente.
| Requisição |
|
| Método |
POST |
| URL |
/api/v1/clientes/{id}/referencias_comerciais |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_comerciais |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
razaoSocial |
String |
60 |
Sim |
Razão social |
cnpj |
String |
18 |
Não |
CNPJ |
contato |
String |
60 |
Não |
Nome do contato |
telefone |
String |
20 |
Sim |
Número telefone |
email |
String |
100 |
Não |
E-mail |
inscricaoEstadual |
String |
20 |
Não |
Número da inscrição ou a palavra ISENTO |
localizacao |
String |
60 |
Não |
Localização |
observacao |
String |
200 |
Não |
Observação |
{
"razaoSocial": "Referencia comercial",
"cnpj": "00.000.000/000-01",
"contato": "Pessoa de contato",
"telefone": "(49) 0000-0000",
"email": "teste@teste.com.br",
"inscricaoEstadual": "ISENTO",
"localizacao": "Maravilha",
"observacao": "Observações"
}
Resposta
A API retornará o código identificador da referência comercial inserida.
Estrutura de dados do resposta
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
id |
Integer |
- |
Sim |
Código identificador da referência comercial |
Exemplo de resposta
{
"id": 1
}
Editar referência comercial
Atualiza referência comercial de um cliente.
| Requisição |
|
| Método |
PUT |
| URL |
/api/v1/clientes/{id}/referencias_comerciais/{referenciaComercialId} |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
referenciaComercialId |
Código identificador da referência comercial |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_comerciais/1 |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
razaoSocial |
String |
60 |
Sim |
Razão social |
cnpj |
String |
18 |
Não |
CNPJ |
contato |
String |
60 |
Não |
Nome do contato |
telefone |
String |
20 |
Sim |
Número telefone |
email |
String |
100 |
Não |
E-mail |
inscricaoEstadual |
String |
20 |
Não |
Número da inscrição ou a palavra ISENTO |
localizacao |
String |
60 |
Não |
Localização |
observacao |
String |
200 |
Não |
Observação |
{
"razaoSocial": "Referencia comercial",
"cnpj": "00.000.000/000-01",
"contato": "Pessoa de contato",
"telefone": "(49) 0000-0000",
"email": "teste@teste.com.br",
"inscricaoEstadual": "ISENTO",
"localizacao": "Maravilha",
"observacao": "Observações"
}
Excluir referência comercial
Exclui a referência comercial de um cliente.
| Requisição |
|
| Método |
DELETE |
| URL |
/api/v1/clientes/{id}/referencias_comerciais/{referenciaComercialId} |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
referenciaComercialId |
Código identificador da referência comercial |
| Exemplo de uso |
/api/v1/clientes/12345/referencias_comerciais/1 |
