Pular para o conteúdo principal
GET
Get a fee schedule

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

scheduleId
string<uuid>
obrigatório

The unique identifier of the fee schedule. Schedule ID

Resposta

Successfully retrieved fee schedule

applicationOrder
enum<string>
obrigatório

How items combine. PARALLEL applies every item to the same gross base; CASCADING applies each item to the net remaining after prior items.

Opções disponíveis:
PARALLEL,
CASCADING
Exemplo:

"PARALLEL"

createdAt
string
obrigatório

Creation timestamp in RFC 3339 format.

Exemplo:

"2025-01-15T10:30:00Z"

currency
string
obrigatório

ISO 4217 currency code the schedule's amounts are denominated in.

Exemplo:

"USD"

id
string
obrigatório

Unique identifier of the fee schedule.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

items
object[] | null
obrigatório

Fee items that make up the schedule.

Maximum array length: 100
name
string
obrigatório

Human-readable name of the fee schedule.

Exemplo:

"Card Processing - Visa"

roundingMode
enum<string>
obrigatório

Rounding strategy. HALF_UP rounds halves away from zero; BANKERS rounds halves to the nearest even digit; FLOOR rounds down; CEIL rounds up; TRUNCATE drops extra digits.

Opções disponíveis:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Exemplo:

"HALF_UP"

roundingScale
integer<int64>
obrigatório

Number of decimal places fee amounts are rounded to.

Exemplo:

2

tenantId
string
obrigatório

Identifier of the tenant that owns the schedule.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt
string
obrigatório

Last update timestamp in RFC 3339 format.

Exemplo:

"2025-01-15T10:30:00Z"

usedByContexts
integer<int64>
obrigatório

Number of distinct contexts whose fee rules reference this schedule. Computed at read time from the fee rules that reference this schedule (never persisted).

Exemplo:

2