Skip to main content
O FareBenefitCategory representa o catálogo genérico de benefícios tarifários, como idoso, estudante, PCD, jovem baixa renda ou acompanhante. Esta entidade não pertence a uma empresa específica; ela apenas define o que é o benefício.

​
Campos

CampoTipoDescrição
fareBenefitCategoryIdUUIDIdentificador único
codeStringCódigo estável da categoria
nameStringNome exibido da categoria
descriptionString?Descrição operacional da categoria
typeFareBenefitTypeTipo principal do benefício
requiredDocumentTypesString[]Tipos de documento exigidos para solicitar a categoria
eligibilityRulesJson?Regras descritivas de elegibilidade
statusFareBenefitCategoryStatusStatus da categoria
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização
deletedByUUID?Usuário que removeu o registro, quando aplicável
deletedAtDateTime?Data de remoção lógica

​
Relacionamentos

​
Regras de Negócio

  • code deve ser único no catálogo global de benefícios.
  • type define se a categoria representa gratuidade total ou desconto.
  • requiredDocumentTypes orienta quais documentos normalmente comprovam a categoria.
  • eligibilityRules guarda regras descritivas; a validação executável deve ficar no backend.
  • Categorias inativas não podem receber novos programas.
  • A regra de aplicação, escopo, vigência, percentual e responsável pela análise ficam em FareBenefitProgram.
  • createdBy, updatedBy e deletedBy seguem o padrão de auditoria do DEVMOB e registram o usuário responsável pela mutação, quando aplicável.

​
Exemplos de categorias

CategoriaTipoObservação
Gratuidade para idosoGRATUITYCatálogo genérico, normalmente usado por regra legal ou regulatória
Meia passagem estudantilDISCOUNTCatálogo genérico; percentual, validade e documentos dependem do programa
Gratuidade PCDGRATUITYCatálogo genérico; documentos e validade dependem da regra configurada
Desconto jovem baixa rendaDISCOUNTCatálogo genérico; pode exigir comprovante cadastral e vigência limitada
Desconto para funcionário conveniadoDISCOUNTCatálogo genérico, normalmente usado em programa comercial de empresa

​
Enums

​
FareBenefitType

ValorDescrição
GRATUITYBenefício de gratuidade total
DISCOUNTBenefício de desconto parcial

​
FareBenefitCategoryStatus

ValorDescrição
ACTIVECategoria disponível para uso
INACTIVECategoria indisponível para novas solicitações

​
Example

{
  "fareBenefitCategoryId": "0197f710-b826-77f0-a60b-6c62b9fdd301",
  "code": "STUDENT_HALF_FARE",
  "name": "Meia passagem estudantil",
  "description": "Desconto para estudantes com documentação aprovada",
  "type": "DISCOUNT",
  "requiredDocumentTypes": ["STUDENT_ID", "ENROLLMENT_PROOF"],
  "eligibilityRules": {
    "requiresActiveEnrollment": true
  },
  "status": "ACTIVE",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-04T10:00:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-04T10:00:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}