Saltar al contenido principal
GET
Get a fee schedule

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-Request-Id
string

A unique identifier for tracing the request across services.

Parámetros de ruta

scheduleId
string<uuid>
requerido

The unique identifier of the fee schedule. Schedule ID

Respuesta

Successfully retrieved fee schedule

applicationOrder
enum<string>
requerido

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

Opciones disponibles:
PARALLEL,
CASCADING
Ejemplo:

"PARALLEL"

createdAt
string
requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

currency
string
requerido

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

Ejemplo:

"USD"

id
string
requerido

Unique identifier of the fee schedule.

Ejemplo:

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

items
object[] | null
requerido

Fee items that make up the schedule.

Maximum array length: 100
name
string
requerido

Human-readable name of the fee schedule.

Ejemplo:

"Card Processing - Visa"

roundingMode
enum<string>
requerido

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.

Opciones disponibles:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Ejemplo:

"HALF_UP"

roundingScale
integer<int64>
requerido

Number of decimal places fee amounts are rounded to.

Ejemplo:

2

tenantId
string
requerido

Identifier of the tenant that owns the schedule.

Ejemplo:

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

updatedAt
string
requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

usedByContexts
integer<int64>
requerido

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

Ejemplo:

2