Docs

Get Rate Card

GET /rate-cards/{rateCardId}

GET/rate-cards/{rateCardId}

Returns one rate card with its minimums, rates and reset definitions, plus the type that owns it. A composite owner's cards are charge-only. The id comes from Resources_GetResourceTypeRateCards.

Path Parameters

FieldTypeRequiredDescription
rateCardIduuidRequired

Response

FieldTypeDescription
iduuid
namestring| null
costMinimumAmountnumber| null
chargeMinimumAmountnumber| null
costMinimumUnitsnumber| null
chargeMinimumUnitsnumber| null
minimumUnitsPeriodstring| null
periodResetDefinitionIduuid| null
minimumAmountResetDefinitionIduuid| null
minimumUnitsResetDefinitionIduuid| null
orgCorrelationIduuid| null
rateCountinteger
ratesGetRateCardResponseRateDetail[]| null
resetDefinitionsGetRateCardResponseResetDefinitionDetail[]| null
ownerGetRateCardResponseOwnerInfo

GetRateCardResponseRateDetail

FieldTypeDescription
iduuid
resourceStateIduuid
stateNamestring| null
stateColorstring| null
stateIconstring| null
periodstring| null
costFixednumber
costVariablenumber
chargeFixednumber
chargeVariablenumber
coversHoursnumber| null
costMinimumBillableUnitsnumber| null
chargeMinimumBillableUnitsnumber| null
resetDefinitionIduuid| null

GetRateCardResponseResetDefinitionDetail

FieldTypeDescription
iduuid
namestring| null
resetTypestring| null
blockTypeIduuid| null
blockTypeNamestring| null
minDurationnumber| null
durationUnitstring| null
periodstring| null
periodStartDaystring| null

GetRateCardResponseOwnerInfo

FieldTypeDescription
resourceTypeIduuid
namestring| null
trackingTypestring| null