Skip to main content
GET
/
api
/
v1
/
ops
/
transport-operator-subsidy-settlements
/
{transportOperatorSubsidySettlementId}
Get Transport Operator Subsidy Settlement
curl --request GET \
  --url https://api.example.com/api/v1/ops/transport-operator-subsidy-settlements/{transportOperatorSubsidySettlementId} \
  --header 'Authorization: Bearer <token>'
{
  "transportOperatorSubsidySettlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subsidyRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z",
  "tripCount": 123,
  "auditedDistanceKm": 123,
  "amountPerKm": 123,
  "grossAmount": 123,
  "approvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approvedAt": "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"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
transportOperatorSubsidySettlementId
string<uuid>
required

Transport operator subsidy settlement 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

Fechamento auditável de subsídio por km executado

​
transportOperatorSubsidySettlementId
string<uuid>
required

Identificador único

​
cooperativeId
string<uuid>
required

Cooperativa responsável pela operação

​
transportOperatorId
string<uuid>
required

Permissionário contemplado

​
routeId
string<uuid> | null
required

Rota consolidada, quando o fechamento for por rota

​
tripId
string<uuid> | null
required

Trip específica, quando o fechamento for unitário

​
subsidyRuleId
string<uuid>
required

Regra de subsídio usada no cálculo

​
periodStart
string<date-time>
required

Início do período auditado

​
periodEnd
string<date-time>
required

Fim do período auditado

​
tripCount
integer
required

Quantidade de trips consideradas

​
auditedDistanceKm
number
required

Quilometragem auditada usada no cálculo

​
amountPerKm
integer
required

Valor por quilômetro em centavos no momento do cálculo

​
grossAmount
integer
required

Valor bruto calculado em centavos

​
status
enum<string>
required

Status do fechamento

Available options:
PENDING,
UNDER_REVIEW,
APPROVED,
REJECTED,
PAID
​
approvedBy
string<uuid> | null
required

Usuário que aprovou o fechamento

​
approvedAt
string<date-time> | null
required

Data de aprovação

​
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