Skip to main content
GET
/
api
/
v1
/
bko
/
benefit-programs
/
{fareBenefitProgramId}
Get Benefit Program
curl --request GET \
  --url https://api.example.com/api/v1/bko/benefit-programs/{fareBenefitProgramId}
{
  "fareBenefitProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fareBenefitCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "discountValue": 123,
  "maxDiscountAmount": 123,
  "priority": 123,
  "cumulative": true,
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "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

​
fareBenefitProgramId
string<uuid>
required

Fare benefit program 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

Programa que define como uma categoria de benefício tarifário é aplicada

​
fareBenefitProgramId
string<uuid>
required

Identificador único

​
fareBenefitCategoryId
string<uuid>
required

Categoria genérica do benefício

​
companyId
string<uuid> | null
required

Empresa dona do programa, quando for benefício comercial da empresa

​
routeId
string<uuid> | null
required

Rota em que o programa se aplica, quando houver restrição por rota

​
code
string
required

Código estável do programa

​
name
string
required

Nome exibido do programa

​
description
string | null
required

Descrição operacional do programa

​
ownerType
enum<string>
required

Dono da regra de aplicação

Available options:
PLATFORM,
COMPANY
​
reviewOwnerType
enum<string>
required

Responsável por validar documentos e aprovar solicitações

Available options:
PLATFORM,
COMPANY
​
discountType
enum<string>
required

Forma de cálculo do benefício

Available options:
PERCENTAGE,
FIXED_AMOUNT
​
discountValue
integer
required

Valor do desconto em basis points ou centavos, conforme discountType

​
maxDiscountAmount
integer | null
required

Valor máximo de desconto em centavos

​
priority
integer
required

Prioridade de aplicação quando mais de um programa é elegível

​
cumulative
boolean
required

Indica se pode acumular com outro benefício

​
startsAt
string<date-time> | null
required

Início da vigência

​
endsAt
string<date-time> | null
required

Fim da vigência

​
status
enum<string>
required

Status do programa

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