Settings Rate Categories

List Rate Categories

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of rate categories

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/rateCategories

HTTPcURLJavaScriptPython

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

{
  "totalRows": 1,
  "rows": [
    {
      "id": "preparation",
      "label": "Preparation Work",
      "active": true,
      "quoteTypes": [
        "interior",
        "exterior"
      ]
    }
  ]
}

Create Rate Category

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

labelstringRequired

The display label of the rate category.

activebooleanOptional

Whether this rate category is active & usable

quoteTypesstring[]Optional

Quote types this rate category applies to

Responses

200

Successfully created rate category

application/json

idstringRequired

The unique ID of the rate category.

labelstringRequired

The display label of the rate category.

activebooleanOptional

Whether this rate category is active & usable

quoteTypesstring[]Optional

Quote types this rate category applies to

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Rate category already exists

application/json

500

Unexpected error

application/json

post/settings/rateCategories

HTTPcURLJavaScriptPython

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

{
  "label": "Interior Painting",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

{
  "id": "preparation",
  "label": "Preparation Work",
  "active": true,
  "quoteTypes": [
    "interior",
    "exterior"
  ]
}

Retrieve Rate Category

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate Category

Responses

200

Details about the rate category

application/json

idstringRequired

The unique ID of the rate category.

labelstringRequired

The display label of the rate category.

activebooleanOptional

Whether this rate category is active & usable

quoteTypesstring[]Optional

Quote types this rate category applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/rateCategories/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "preparation",
  "label": "Preparation Work",
  "active": true,
  "quoteTypes": [
    "interior",
    "exterior"
  ]
}

Update Rate Category

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate Category

Body

application/json

idstringRequired

The unique ID of the rate category.

labelstringRequired

The display label of the rate category.

activebooleanOptional

Whether this rate category is active & usable

quoteTypesstring[]Optional

Quote types this rate category applies to

Responses

200

Successfully updated rate category

application/json

idstringRequired

The unique ID of the rate category.

labelstringRequired

The display label of the rate category.

activebooleanOptional

Whether this rate category is active & usable

quoteTypesstring[]Optional

Quote types this rate category applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/rateCategories/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "preparation",
  "label": "Preparation Work",
  "active": true,
  "quoteTypes": [
    "interior",
    "exterior"
  ]
}

{
  "id": "preparation",
  "label": "Preparation Work",
  "active": true,
  "quoteTypes": [
    "interior",
    "exterior"
  ]
}

Delete Rate Category

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate Category

Responses

204

Rate category 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/rateCategories/{id}

HTTPcURLJavaScriptPython

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

No content