Skip to main content
GET
/
api
/
v1
/
bko
/
benefit-categories
/
{fareBenefitCategoryId}
Get Benefit Category
curl --request GET \
  --url https://api.example.com/api/v1/bko/benefit-categories/{fareBenefitCategoryId}
{
  "fareBenefitCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "requiredDocumentTypes": [
    "<string>"
  ],
  "eligibilityRules": {},
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
fareBenefitCategoryId
string<uuid>
required

Fare benefit category identifier

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Categoria de gratuidade ou desconto disponível para passageiros

​
fareBenefitCategoryId
string<uuid>
required

Identificador único

​
code
string
required

Código estável da categoria

​
name
string
required

Nome exibido da categoria

​
description
string | null
required

Descrição operacional da categoria

​
type
enum<string>
required

Tipo principal do benefício

Available options:
GRATUITY,
DISCOUNT
​
requiredDocumentTypes
string[]
required

Tipos de documento exigidos para solicitar a categoria

​
eligibilityRules
object | null
required

Regras descritivas de elegibilidade

​
status
enum<string>
required

Status da categoria

Available options:
ACTIVE,
INACTIVE
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

Usuário que removeu o registro, quando aplicável

​
deletedAt
string<date-time> | null
required

Data de remoção lógica