Gets a Quote

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

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

Query parameters
quoteId
string (uuid) Required
Responses
200

Successful Response

Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDetailDto)
LeadId
integer (int32)

The ID of the Lead

QuoteId
string (uuid)

The ID of the Quote

Example00000000-0000-0000-0000-000000000000
CustomerInformationId
integer (int32)

If Booked, the ID of the Customer

HomeInformationId
integer (int32)

If Booked, the ID of the Home

FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string

MaidCentral URL for the Partner

MaidServiceQuoteUrl
string

The URL to the Online Quoting Form

BookNowUrl
string

The URL to the Online Quoting Form to book immediately

ActivateUrl
string

If Booked, the Customer Portal Invite URL

CustomerSourceId
integer (int32)
CustomerSourceName
string

The name of the Customer Source

BillingTermsId
integer (int32)
BillingTermsName
string

The name of the Billing Terms

ScopeGroupId
integer (int32)

The ID of the Scope Group

ScopeGroupName
string

The name of the Scope Group

HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
Scopes
Array of object (CustomerQuoteDetailScopeDto)

List of Scopes of Work

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

Questions
Array of object (ApiQuoteQuestionOutputDto)
object

Represents question and answer saved

QuestionText
string
QuestionId
integer (int32)
Answer
string
AnswerIds
string
QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDetailDto)
LeadId
integer (int32)

The ID of the Lead

QuoteId
string (uuid)

The ID of the Quote

Example00000000-0000-0000-0000-000000000000
CustomerInformationId
integer (int32)

If Booked, the ID of the Customer

HomeInformationId
integer (int32)

If Booked, the ID of the Home

FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string

MaidCentral URL for the Partner

MaidServiceQuoteUrl
string

The URL to the Online Quoting Form

BookNowUrl
string

The URL to the Online Quoting Form to book immediately

ActivateUrl
string

If Booked, the Customer Portal Invite URL

CustomerSourceId
integer (int32)
CustomerSourceName
string

The name of the Customer Source

BillingTermsId
integer (int32)
BillingTermsName
string

The name of the Billing Terms

ScopeGroupId
integer (int32)

The ID of the Scope Group

ScopeGroupName
string

The name of the Scope Group

HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
Scopes
Array of object (CustomerQuoteDetailScopeDto)

List of Scopes of Work

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

Questions
Array of object (ApiQuoteQuestionOutputDto)
object

Represents question and answer saved

QuestionText
string
QuestionId
integer (int32)
Answer
string
AnswerIds
string
QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDetailDto)
LeadId
integer (int32)

The ID of the Lead

QuoteId
string (uuid)

The ID of the Quote

Example00000000-0000-0000-0000-000000000000
CustomerInformationId
integer (int32)

If Booked, the ID of the Customer

HomeInformationId
integer (int32)

If Booked, the ID of the Home

FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string

MaidCentral URL for the Partner

MaidServiceQuoteUrl
string

The URL to the Online Quoting Form

BookNowUrl
string

The URL to the Online Quoting Form to book immediately

ActivateUrl
string

If Booked, the Customer Portal Invite URL

CustomerSourceId
integer (int32)
CustomerSourceName
string

The name of the Customer Source

BillingTermsId
integer (int32)
BillingTermsName
string

The name of the Billing Terms

ScopeGroupId
integer (int32)

The ID of the Scope Group

ScopeGroupName
string

The name of the Scope Group

HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
Scopes
Array of object (CustomerQuoteDetailScopeDto)

List of Scopes of Work

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

Questions
Array of object (ApiQuoteQuestionOutputDto)
object

Represents question and answer saved

QuestionText
string
QuestionId
integer (int32)
Answer
string
AnswerIds
string
QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDetailDto)
LeadId
integer (int32)

The ID of the Lead

QuoteId
string (uuid)

The ID of the Quote

Example00000000-0000-0000-0000-000000000000
CustomerInformationId
integer (int32)

If Booked, the ID of the Customer

HomeInformationId
integer (int32)

If Booked, the ID of the Home

FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string

MaidCentral URL for the Partner

MaidServiceQuoteUrl
string

The URL to the Online Quoting Form

BookNowUrl
string

The URL to the Online Quoting Form to book immediately

ActivateUrl
string

If Booked, the Customer Portal Invite URL

CustomerSourceId
integer (int32)
CustomerSourceName
string

The name of the Customer Source

BillingTermsId
integer (int32)
BillingTermsName
string

The name of the Billing Terms

ScopeGroupId
integer (int32)

The ID of the Scope Group

ScopeGroupName
string

The name of the Scope Group

HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
Scopes
Array of object (CustomerQuoteDetailScopeDto)

List of Scopes of Work

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

Questions
Array of object (ApiQuoteQuestionOutputDto)
object

Represents question and answer saved

QuestionText
string
QuestionId
integer (int32)
Answer
string
AnswerIds
string
QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDetailDto)
LeadId
integer (int32)

The ID of the Lead

QuoteId
string (uuid)

The ID of the Quote

Example00000000-0000-0000-0000-000000000000
CustomerInformationId
integer (int32)

If Booked, the ID of the Customer

HomeInformationId
integer (int32)

If Booked, the ID of the Home

FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string

MaidCentral URL for the Partner

MaidServiceQuoteUrl
string

The URL to the Online Quoting Form

BookNowUrl
string

The URL to the Online Quoting Form to book immediately

ActivateUrl
string

If Booked, the Customer Portal Invite URL

CustomerSourceId
integer (int32)
CustomerSourceName
string

The name of the Customer Source

BillingTermsId
integer (int32)
BillingTermsName
string

The name of the Billing Terms

ScopeGroupId
integer (int32)

The ID of the Scope Group

ScopeGroupName
string

The name of the Scope Group

HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
Scopes
Array of object (CustomerQuoteDetailScopeDto)

List of Scopes of Work

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

Questions
Array of object (ApiQuoteQuestionOutputDto)
object

Represents question and answer saved

QuestionText
string
QuestionId
integer (int32)
Answer
string
AnswerIds
string
QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

InnerException
string
StatusCode
integer (int32)