Calculate Price without creating a lead

Updated

8 minute(s) read

Prev Next

Post

/api/Lead/CalculatePrice

Use this endpoint to retrieve pricing without providing contact information. No records are created in the system.

When to use:

Skip this if you plan to create both a Lead and Quote, since the Create Quote endpoint already provides pricing information
Use when you want to show pricing first, then create Lead/Quote records only if the user proceeds

Example workflow:

Call Calculate Price to show initial pricing
If user accepts, proceed with Create Lead → Create Quote flow

Security

HTTP

Type bearer

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

Body parameters

Expand All

object

Get Pricing

PostalCode

string

ScopeGroupId

integer (int32) Required

ScopesOfWork

Array of object (DetailDto) Required

List Scopes of Work

object

ScopeOfWorkId

integer (int32) Required

FrequencyId

string Required

Valid options are supplied via /api/Lead/ScopeGroups

BaseFee

number (double)

Optional, to override the calculated price for this Frequency/Scope

RateModifications

Array of object (RateModDto)

Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=

object

Quantity

integer (int32) Required

Quantity of the rate modification, must not be 0

RateModificationId

integer (int32) Required

IsRecurring

boolean

Questions

Array of object (ApiQuoteQuestionDto) Required

Valid options are supplied via /api/Lead/Questions

object

Represents answering a question

QuestionId

integer (int32) Required

Answer

string Required

Answers to Multiple Select List should be comma separated AnswerId, everything else should be posted as string, Select Lists should be the AnswerId

Responses

200

Successful Response

Expand All

object

IsSuccess

boolean

Message

string

Result

Array of object (CustomerQuoteDetailScopeDto)

object

ScopeId

integer (int32)

ScopeName

string

The name of the Scope

Frequencies

Array of object (CustomerQuoteDetailScopeFrequencyDto)

List of Frequencies and costs

object

Quote by Scope and Frequency

IsBooked

boolean

If true, this scope/frequency is booked

IsInterested

boolean

If true, this scope/frequency is marked as Interested

FrequencyId

string

FrequencyName

string

The name of the Frequency

MinimumCost

number (double)

The minimum cost of this frequency

AdjustedBaseCost

number (double)

The adjusted cost, (using rounding settings)

CalculatedBaseCost

number (double)

The calculated cost

TotalBaseHours

number (double)

The amount of time in minutes for this scope/frequency to perform the work

TotalRecurringCost

number (double)

The total recurring cost, including RateModifications

TotalFirstJobCost

number (double)

The total first job cost, including RateModifications

TotalRecurringHours

number (double)

The total recurring hours, including RateModifications

TotalFirstJobHours

number (double)

The total first job hours, including RateModifications

RateModifications

Array of object (CustomerQuoteDetailRateModificationOutputDto)

List of Rate Modifications and costs

object

Quantity

integer (int32)

RateModificationId

integer (int32)

IsRecurring

boolean

Name

string

CalculatedCost

number (double)

CalculatedHours

number (double)

PriceCalculation

string

How the price is calculated for this frequency

InnerException

string

StatusCode

integer (int32)

Was this article helpful?