Cria um cliente

POST /api/{userId}/establishment/{establishmentId}/clients/new

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento

Requisição

• Método: POST
• Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/new
• Headers: Authorization, Accept: application/json, Content-Type: application/json
• Autorização: envie o token no header Authorization: Bearer <YOUR_API_TOKEN>.

Corpo (JSON)

Campos obrigatórios

Campo	Tipo	Descrição
establishmentId	number	Identificador do estabelecimento
name	string	Nome do cliente (não pode ser vazio)
clientTypeId	number	Tipo de cliente

Campos opcionais — cadastro (jump_clients)

Aceitos pelo modelo (demais chaves são ignoradas se não forem atribuíveis). documentId normaliza dígitos e define documentIdType (1 CPF / 2 CNPJ) automaticamente.

Campo	Tipo	Descrição
email	string	E-mail; se já existir cliente com o mesmo e-mail no contexto, a API pode apenas vincular configurações ao registro existente
password	string	Senha (se aplicável ao fluxo)
documentId	string	CPF/CNPJ (caracteres não numéricos são removidos)
dateOfBirth	string	Data de nascimento (YYYY-MM-DD); vazio vira 0001-01-01
postalCode	string	CEP
street	string	Logradouro
streetNumber	string / number	Número; vazio vira null
streetComplement	string	Complemento
district	string	Bairro
city	string	Cidade
state	string	UF
phones	array	Telefones (é enviado como JSON no banco; omitir usa lista vazia)
vehicles	array	Veículos; na criação padrão é fixado como lista vazia []
mainClientId	string	Cliente principal vinculado, se houver

Campos opcionais — configuração do vínculo (jump_client_settings)

Campo	Tipo	Descrição
comments	string	Observações do vínculo cliente–estabelecimento

Campos de cobrança recorrente (amount, invoiceDueDay, frequencyId, multas, etc.) são tratados em fluxos específicos (ex.: ajuste de cobrança após o cadastro). Este endpoint cria registro de cliente, vínculo e dispara sincronização conforme implementação.

Nuâncias por clientTypeId (1, 2 e 4)

Esta documentação considera os tipos:

• 1 Avulso
• 2 Fatura fixa / mensalista
• 4 Pós-pago

Na criação, o tipo influencia defaults operacionais (por exemplo, permissões de dias/semana e como os próximos passos de cobrança/fatura serão configurados). Recomendação:

• Para clientTypeId = 2 (mensalista), após criar o cliente, siga com a configuração de cobrança em PUT /clients/{clientId}/charge.
• Para clientTypeId = 4 (pós-pago), normalmente você também configura cobrança e restrições e, ao longo do ciclo, usa fechamento/pagamento de faturas conforme o fluxo financeiro.

Formato da resposta (JSON)

• Sucesso (HTTP 200): { "response": "success", "data": <payload> }
• Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }
• Não autorizado / permissão: Autorização

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
  "response": "success",
  "data": {
    "clientId": "884120260325144207",
    "name": "Ana Carolina Mendes",
    "email": "[email protected]",
    "documentId": "",
    "documentIdType": 1,
    "dateOfBirth": "1988-03-22",
    "postalCode": "30130-100",
    "street": "Rua da Bahia",
    "streetNumber": "847",
    "streetComplement": "Apto 502",
    "district": "Lourdes",
    "city": "Belo Horizonte",
    "state": "MG",
    "phones": ["+5531987654321"],
    "vehicles": [],
    "mainClientId": null,
    "establishmentId": 8841,
    "clientTypeId": 1,
    "restrictionTypePrice": null,
    "amount": "0.00",
    "closingDays": 0,
    "toleranceDays": 0,
    "invoiceDueDay": 0,
    "contractDueDate": "0001-01-01",
    "frequencyId": 1,
    "penalty": "0.00",
    "penaltyType": 1,
    "period": 0,
    "startTime": "00:00:00",
    "endTime": "00:00:00",
    "weekDaysPermission": [1, 2, 3, 4, 5, 6, 7],
    "vacancies": null,
    "cards": [],
    "typePricesLink": [],
    "servicesLink": [],
    "comments": "Cadastro via integração — tarifa mensalista",
    "status": 1,
    "typePrices": [],
    "services": []
  }
}