TItiflux
Contratos

Criar lembrete de consumo no contrato

Changed on

Cria um lembrete de consumo no contrato. Quando o consumo do ciclo atinge uma das porcentagens, os e-mails do lembrete recebem o aviso.

Regras e validações:

  • Só contratos de consumo: Crédito, Horas, Limite de atendimento e Horas cumulativas. O Crédito Compartilhado usa POST /contract-groups/{contract_group_id}/consumption-reminders

  • Informe ao menos uma porcentagem ou um e-mail. Um lembrete só avisa quando tem as duas coisas

  • Porcentagens inteiras de 1 a 999, sem repetir, até 10 por lembrete. Acima de 100% avisa o consumo excedente

  • Até 10 lembretes por contrato

  • shifts_only e contract_and_shifts só em Horas, Limite de atendimento e Horas cumulativas

  • Sem aviso retroativo: as porcentagens que o consumo do ciclo atual já passou só avisam no próximo ciclo

post/contracts/{contract_id}/consumption-reminders

Request

  • Base URL
    https://api.tiflux.com/api/v2
  • Auth
    HTTP bearer

Request body

percentagesinteger[]

(%) Porcentagens de consumo que disparam o aviso: inteiros de 1 a 999, sem repetir, até 10. Acima de 100% avisa o consumo excedente

emailsstring[]

E-mails que recebem o aviso

alert_scope'contract_only' | 'shifts_only' | 'contract_and_shifts'

Consumo avisado: contract_only (contrato), shifts_only (deslocamentos) ou contract_and_shifts (os dois). Deslocamentos só valem para Horas, Limite de atendimento e Horas cumulativas

Response

Lembrete criado

idnumber required

Identificador do lembrete

percentagesnumber[] required

(%) Porcentagens de consumo que disparam o aviso

emailsstring[] required

E-mails que recebem o aviso

alert_scope'contract_only' | 'shifts_only' | 'contract_and_shifts' required

Consumo avisado: contract_only (contrato), shifts_only (deslocamentos) ou contract_and_shifts (os dois). Deslocamentos só valem para Horas, Limite de atendimento e Horas cumulativas

Changes