Configura cobrança do cliente

PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/charge

Atualiza as configurações de cobrança/recorrência do cliente (vencimento, frequência, tolerância, multa, valor, dias de fechamento, etc.). Este endpoint é o “centro” do fluxo de mensalista/pós-pago.

Parâmetros de rota

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

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
establishmentId	number	sim	Estabelecimento
userId	number	sim	Usuário executor
frequencyId	number	sim	Frequência (regra interna)
invoiceDueDay	number	não	Dia do vencimento (0–31)
invoiceDate	string	não	Data base (YYYY-MM-DD) para primeira fatura (quando não existe fatura)
contractDueDate	string	não	Data de vencimento de contrato (YYYY-MM-DD)
toleranceDays	number	não	Dias de tolerância
penalty	number	não	Multa (valor ou percentual; ver penaltyType)
penaltyType	number	não	Tipo da multa
amount	number	não	Valor recorrente
closingDays	number	não	Dias para fechamento antes do vencimento (útil para pós-pago)
clientTypeId	number	não	Tipo do cliente (quando o backend usa para regras específicas)

Requisição

• Método: PUT
• Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/charge
• Headers: Authorization, Accept: application/json, Content-Type: application/json

Formato da resposta (JSON)

• Sucesso (HTTP 200): { "response": "success", "data": <payload> }
• Erro de validação (HTTP 422): retorna os erros por campo
• Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }

Exemplo de resposta (JSON)

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

{
  "response": "success",
  "data": {
    "clientId": "772420260215093421",
    "establishmentId": 7724,
    "frequencyId": 1,
    "invoiceDueDay": 10,
    "contractDueDate": "2027-02-15",
    "toleranceDays": 3,
    "penalty": "2.00",
    "penaltyType": 1,
    "amount": 350.0,
    "closingDays": 5,
    "clientTypeId": 2,
    "status": 1
  }
}

Nuâncias por clientTypeId

• clientTypeId = 2 (Fatura fixa / mensalista): este endpoint normalmente é usado logo após a criação para garantir que exista a primeira fatura e que o vencimento/frequência fiquem corretos.
• clientTypeId = 4 (Pós-pago): closingDays e regras de fechamento ganham importância, pois o ciclo pode envolver fechamento de fatura e geração da próxima fatura.
• clientTypeId = 1 (Avulso): geralmente usa menos recorrência; ainda assim é possível ter parâmetros preenchidos, dependendo do uso.

Passo a passo recomendado (fluxo completo)

1. Criar cliente: POST /clients/new
2. Configurar cobrança: PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/charge
3. Configurar restrições (se aplicável): PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/restrictions
4. Vincular tabelas/serviços (se aplicável):
   • PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/type-prices-link
   • PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/services-link
5. Automação de cobrança (se aplicável): PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/charge-automations