Gets a list of Rate Modifications for a Scope

Updated
  • 3 minute(s) read
Prev Next
Get
/api/Lead/RateModifications
Security
HTTP
Type bearer

Enter the token obtained from the /token endpoint. Use the format: Bearer

Query parameters
scopeId
integer (int32) Required
Responses
200

Successful Response

Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (RateModLeadOutputDto)
object
RateModificationId
integer (int32)

The ID of the rate modification

Name
string

The short name of the rate modification

Description
string

Additional information about the rate modification

RateModificationType
string

The type of the RateModification (Cleaning Extras, Other, Discounts)

IsPercentage
boolean

If true, the rate modification is a percentage of the base fee

IsRequired
boolean

If true, the rate modification is a required for this scope

ScopeId
integer (int32)

The Scope this rate modification is associated with

Cost
number (double)

Cost of the rate modification

CostDisplay
string

The cost of the rate modification as a string

CostCalcType
integer (int32)
Valid values[ 0, 1 ]
CostCalcDescription
string

The method used to calculate the cost of the rate modification

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (RateModLeadOutputDto)
object
RateModificationId
integer (int32)

The ID of the rate modification

Name
string

The short name of the rate modification

Description
string

Additional information about the rate modification

RateModificationType
string

The type of the RateModification (Cleaning Extras, Other, Discounts)

IsPercentage
boolean

If true, the rate modification is a percentage of the base fee

IsRequired
boolean

If true, the rate modification is a required for this scope

ScopeId
integer (int32)

The Scope this rate modification is associated with

Cost
number (double)

Cost of the rate modification

CostDisplay
string

The cost of the rate modification as a string

CostCalcType
integer (int32)
Valid values[ 0, 1 ]
CostCalcDescription
string

The method used to calculate the cost of the rate modification

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (RateModLeadOutputDto)
object
RateModificationId
integer (int32)

The ID of the rate modification

Name
string

The short name of the rate modification

Description
string

Additional information about the rate modification

RateModificationType
string

The type of the RateModification (Cleaning Extras, Other, Discounts)

IsPercentage
boolean

If true, the rate modification is a percentage of the base fee

IsRequired
boolean

If true, the rate modification is a required for this scope

ScopeId
integer (int32)

The Scope this rate modification is associated with

Cost
number (double)

Cost of the rate modification

CostDisplay
string

The cost of the rate modification as a string

CostCalcType
integer (int32)
Valid values[ 0, 1 ]
CostCalcDescription
string

The method used to calculate the cost of the rate modification

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (RateModLeadOutputDto)
object
RateModificationId
integer (int32)

The ID of the rate modification

Name
string

The short name of the rate modification

Description
string

Additional information about the rate modification

RateModificationType
string

The type of the RateModification (Cleaning Extras, Other, Discounts)

IsPercentage
boolean

If true, the rate modification is a percentage of the base fee

IsRequired
boolean

If true, the rate modification is a required for this scope

ScopeId
integer (int32)

The Scope this rate modification is associated with

Cost
number (double)

Cost of the rate modification

CostDisplay
string

The cost of the rate modification as a string

CostCalcType
integer (int32)
Valid values[ 0, 1 ]
CostCalcDescription
string

The method used to calculate the cost of the rate modification

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (RateModLeadOutputDto)
object
RateModificationId
integer (int32)

The ID of the rate modification

Name
string

The short name of the rate modification

Description
string

Additional information about the rate modification

RateModificationType
string

The type of the RateModification (Cleaning Extras, Other, Discounts)

IsPercentage
boolean

If true, the rate modification is a percentage of the base fee

IsRequired
boolean

If true, the rate modification is a required for this scope

ScopeId
integer (int32)

The Scope this rate modification is associated with

Cost
number (double)

Cost of the rate modification

CostDisplay
string

The cost of the rate modification as a string

CostCalcType
integer (int32)
Valid values[ 0, 1 ]
CostCalcDescription
string

The method used to calculate the cost of the rate modification

InnerException
string
StatusCode
integer (int32)