Clientes
Através dessa rota você pode salvar os dados de um cliente no nosso banco de dados.
Post
| Campo(tipo) | Validação | Descrição | Exemplo |
|---|---|---|---|
| active (boolean) | Flag para soft-delete de clientes | 1 | |
| name (string) | Nome e sobrenome separados por espaço | Nome ou Razão Social | "João Silva" |
| email (string) | Sim | "email@exemplo.com" | |
| type (string) | "individual"/"corporation" (choice) | Tipo de cliente | |
| type (string) | "individual"/"corporation" (choice) | Tipo de cliente | |
| country (string) | ISO3166 alpha2 country code (lowercase) | Nacionalidade | "br" |
| birthday (string) | "YYYY-MM-DD" | Data de Nascimento(Não-Obrigatório caso type="corporation") | |
| address | Objeto de descrição do endereço | ||
| address.street (string) | Rua | ||
| address.country (string) | ISO3166 alpha2 country code (lowercase) | País | "br" |
| address.number (string) | Número | ||
| address.city (string) | Cidade | ||
| address.state (string) | Estado | ||
| address.complementary (string) | Complemento (Não-Obrigatório) | ||
| address.neighborhood (string) | Bairro | ||
| address.zipcode (string) | Números e pontuação de acordo com o país do endereço | CEP | |
| documents (array) | Array de documentos | ||
| documents.*.number (string) | De acordo com documents.type | Número do documento, sem pontuação | 08666043083 |
| documents.*.type (string) | "cpf"/"cnpj"/"passport"/"other" (choice)De acordo com type | Tipo de documento | |
| telephones (array) | Array de telefones | ||
| telephones.*.telephone | "+99(99)99999-9999" | Número de telefone |