Skip to main content

UPowr Quote API (1.0.0)

Download OpenAPI specification:Download

Accept a Quote

Accept a Quote on behalf of a customer - this will trigger the order/installation process for the project as long as the contract has been accepted. A quote must have been approved before it can be accepted. If approval is required use the /{quoteId}/approve endpoint instead and set the accept flag to true. Do not use this to accept quotes that are Awaiting External Approval.

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Approve a Quote

Approve a Quote for publishing to a customer and optionally Accept on behalf of the customer. Use of the optional Acceptance will also accept the contract and void all other quotes, and then trigger the Order/Installation process. When using this flag the API will return before Acceptance happens so you will need to listen for Quote.Accepted and the other events to know when the Order is ready. Use this for quotes that are Awaiting External Approval.

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

query Parameters
accept
boolean

Whether to accept the quote as well (this will mean all other quotes for the project are rejected regardless of state)

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Reject a Quote

Reject a Quote

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Void a Quote

Void a Quote

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

query Parameters
customerId
required
string <uuid>

The unique identifier for an existing customer.

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Request external approval

Request external approval

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Replace a quote file

Replace a quote file

Authorizations:
session
path Parameters
quoteId
required
string <uuid>

The quote ID

fileCode
required
string
Enum: "single_line_diagram" "system_design" "design_markup" "customer_design_markup" "quote"

The name of the file to replace

Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{ }