Settings Quote Types

List Quote Types

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of quote types

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/quoteTypes

HTTPcURLJavaScriptPython

GET /v2/settings/quoteTypes HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "interior",
      "label": "Interior",
      "active": true,
      "defaultHourlyRate": 65,
      "defaultTerms": "standard",
      "defaultAreaType": "room",
      "defaultPresentation": "default",
      "overrideCompanyOptions": false,
      "companyOptions": {
        "name": "Interior Paint Co."
      }
    }
  ]
}

Create Quote Type

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

labelstringRequired

The display label of the quote type.

activebooleanOptional

Whether this quote type is active & usable

defaultHourlyRatenumberOptional

The default hourly rate for this quote type

defaultTermsstringOptional

The default terms template for this quote type

defaultAreaTypestringOptional

The default area type for this quote type

defaultPresentationstringOptional

The default presentation template for this quote type

overrideCompanyOptionsbooleanOptional

Whether this quote type overrides global company options

Responses

200

Successfully created quote type

application/json

idstringRequired

The unique ID of the quote type.

labelstringRequired

The display label of the quote type.

activebooleanOptional

Whether this quote type is active & usable

defaultHourlyRatenumberOptional

The default hourly rate for this quote type

defaultTermsstringOptional

The default terms template for this quote type

defaultAreaTypestringOptional

The default area type for this quote type

defaultPresentationstringOptional

The default presentation template for this quote type

overrideCompanyOptionsbooleanOptional

Whether this quote type overrides global company options

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Quote type already exists

application/json

500

Unexpected error

application/json

post/settings/quoteTypes

HTTPcURLJavaScriptPython

POST /v2/settings/quoteTypes HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "label": "Commercial Interior",
  "active": true,
  "defaultHourlyRate": 75
}

{
  "id": "interior",
  "label": "Interior",
  "active": true,
  "defaultHourlyRate": 65,
  "defaultTerms": "standard",
  "defaultAreaType": "room",
  "defaultPresentation": "default",
  "overrideCompanyOptions": false,
  "companyOptions": {
    "name": "Interior Paint Co."
  }
}

Retrieve Quote Type

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Quote Type

Responses

200

Details about the quote type

application/json

idstringRequired

The unique ID of the quote type.

labelstringRequired

The display label of the quote type.

activebooleanOptional

Whether this quote type is active & usable

defaultHourlyRatenumberOptional

The default hourly rate for this quote type

defaultTermsstringOptional

The default terms template for this quote type

defaultAreaTypestringOptional

The default area type for this quote type

defaultPresentationstringOptional

The default presentation template for this quote type

overrideCompanyOptionsbooleanOptional

Whether this quote type overrides global company options

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/quoteTypes/{id}

HTTPcURLJavaScriptPython

GET /v2/settings/quoteTypes/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "interior",
  "label": "Interior",
  "active": true,
  "defaultHourlyRate": 65,
  "defaultTerms": "standard",
  "defaultAreaType": "room",
  "defaultPresentation": "default",
  "overrideCompanyOptions": false,
  "companyOptions": {
    "name": "Interior Paint Co."
  }
}

Update Quote Type

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Quote Type

Body

application/json

idstringRequired

The unique ID of the quote type.

labelstringRequired

The display label of the quote type.

activebooleanOptional

Whether this quote type is active & usable

defaultHourlyRatenumberOptional

The default hourly rate for this quote type

defaultTermsstringOptional

The default terms template for this quote type

defaultAreaTypestringOptional

The default area type for this quote type

defaultPresentationstringOptional

The default presentation template for this quote type

overrideCompanyOptionsbooleanOptional

Whether this quote type overrides global company options

Responses

200

Successfully updated quote type

application/json

idstringRequired

The unique ID of the quote type.

labelstringRequired

The display label of the quote type.

activebooleanOptional

Whether this quote type is active & usable

defaultHourlyRatenumberOptional

The default hourly rate for this quote type

defaultTermsstringOptional

The default terms template for this quote type

defaultAreaTypestringOptional

The default area type for this quote type

defaultPresentationstringOptional

The default presentation template for this quote type

overrideCompanyOptionsbooleanOptional

Whether this quote type overrides global company options

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/quoteTypes/{id}

HTTPcURLJavaScriptPython

PUT /v2/settings/quoteTypes/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "id": "interior",
  "label": "Interior",
  "active": true,
  "defaultHourlyRate": 65,
  "defaultTerms": "standard",
  "defaultAreaType": "room",
  "defaultPresentation": "default",
  "overrideCompanyOptions": false,
  "companyOptions": {
    "name": "Interior Paint Co."
  }
}

{
  "id": "interior",
  "label": "Interior",
  "active": true,
  "defaultHourlyRate": 65,
  "defaultTerms": "standard",
  "defaultAreaType": "room",
  "defaultPresentation": "default",
  "overrideCompanyOptions": false,
  "companyOptions": {
    "name": "Interior Paint Co."
  }
}

Delete Quote Type

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Quote Type

Responses

204

Quote type successfully deleted

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/settings/quoteTypes/{id}

HTTPcURLJavaScriptPython

DELETE /v2/settings/quoteTypes/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content