Skip to main content
POST
Create billing-role rate

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Create payload for a billing-role rate. Resolve billingRoleId via GET /v1/public/billing-roles. Resolve currencyUnitId via GET /v1/public/units.

billingRoleId
string
required

Id of the billing role the rate applies to. Resolve via GET /v1/public/billing-roles.

Maximum string length: 100
Pattern: \S
Example:

"2b1e1a74-8b22-4c9a-b2d0-2c5e0b2d9f9c"

costRate
number
required

Fully-loaded internal cost per hour (burn-down source).

Required range: x >= 0
Example:

38

billingRate
number
required

External client price per hour (not consumed by budgets).

Required range: x >= 0
Example:

75

currencyUnitId
string
required

Id of the currency unit. Resolve via GET /v1/public/units.

Maximum string length: 100
Pattern: \S
Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

effectiveDate
string<date>
required

Date the rate becomes effective (day-based semantics).

Example:

"2026-01-01"

externalId
string

Optional external system identifier. Must be unique within the organization.

Maximum string length: 255
Example:

"BILLING_ROLE_RATE_2026_Q1"

Response

Billing-role rate created

id
string
billingRoleId
string
billingRoleName
string
costRate
number
billingRate
number
currencyUnitId
string
effectiveDate
string<date>
Example:

"2022-03-10"

externalId
string