Define Transport Operator Subsidy Rule

curl --request POST \ --url https://api.example.com/api/v1/ops/transport-operator-subsidy-rules \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "amountPerKm": 1, "startsAt": "2023-11-07T05:31:56Z", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "endsAt": "2023-11-07T05:31:56Z" } '

{ "transportOperatorSubsidyRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "amountPerKm": 123, "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" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

Body

application/json

Define transport operator subsidy rule payload

transportOperatorId

string<uuid>

required

Transport operator identifier

amountPerKm

integer

required

Amount per km in cents

Required range: x >= 0

distanceSource

enum<string>

required

Distance source

Available options:

PLANNED_ROUTE,

GPS_AUDITED,

ODOMETER_AUDITED,

COMBINED_AUDIT

startsAt

string<date-time>

required

Starts at

routeId

string<uuid> | null

Route identifier

endsAt

string<date-time> | null

Ends at

Response

Created

Regra de subsídio por quilômetro para permissionário

transportOperatorSubsidyRuleId

string<uuid>

required

Identificador único

cooperativeId

string<uuid>

required

Cooperativa da regra

transportOperatorId

string<uuid>

required

Permissionário contemplado

routeId

string<uuid> | null

required

Rota específica, quando a regra for por rota

amountPerKm

integer

required

Valor por quilômetro em centavos

distanceSource

enum<string>

required

Fonte usada para calcular a distância subsidiada

Available options:

PLANNED_ROUTE,

GPS_AUDITED,

ODOMETER_AUDITED,

COMBINED_AUDIT

startsAt

string<date-time>

required

Início da vigência

endsAt

string<date-time> | null

required

Fim da vigência

status

enum<string>

required

Status da regra

Available options:

ACTIVE,

INACTIVE,

EXPIRED

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