Settings Rates

List Rates

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of rates

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/rates

HTTPcURLJavaScriptPython

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

{
  "totalRows": 1,
  "rows": [
    {
      "id": "interior-walls-paint",
      "name": "interior-walls-paint",
      "quoteType": "interior",
      "label": "Interior Wall Painting",
      "clientLabel": "Wall Painting",
      "custom": false,
      "rateType": "sqftWalls",
      "calculationType": "amountPerHour",
      "rateSection": "painting",
      "defaultApps": 2,
      "maxApps": 3,
      "reportText": "Interior wall painting with premium paint",
      "areaReportText": "Wall painting",
      "values": [
        0.15,
        0.12,
        0.1,
        0.08
      ],
      "caption": "Per square foot",
      "useApps": true,
      "active": true,
      "coverage": "400 sqft per gallon",
      "hourlyRate": 65,
      "overrideHourlyRate": false
    }
  ]
}

Create Rate

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringRequired

The unique ID of the rate.

namestringRequired

The unique name of the rate (same as id).

quoteTypestringOptional

The quote type this rate applies to

labelstringRequired

The display label of the rate.

clientLabelstringOptional

The label shown to clients

custombooleanOptional

Whether this is a custom rate

rateTypestringRequired

The type of rate calculation (e.g., sqftWalls, lnft, etc.)

calculationTypestringRequired

How the rate is calculated (e.g., amountPerHour)

rateSectionstringRequired

The rate category/section this rate belongs to

defaultAppsnumberOptional

Default number of applications/coats

maxAppsnumberOptional

Maximum possible applications/coats

reportTextstringOptional

Text shown in reports

areaReportTextstringOptional

Text shown in area reports

valuesnumber[]Required

Array of rate values for different applications

captionstringOptional

Caption or description for the rate

useAppsbooleanOptional

Whether this rate uses coat/application calculations

activebooleanOptional

Whether this rate is active & usable

coveragestringOptional

Coverage information or notes

hourlyRatenumberOptional

Hourly rate if applicable

overrideHourlyRatebooleanOptional

Whether this rate overrides the default hourly rate

Responses

400

Bad Request

application/json

errorsstring[]Optional

Array of error messages

401

Not Authorized

application/json

500

Unexpected error

application/json

501

Not Implemented - Rate creation requires complex document operations

application/json

post/settings/rates

HTTPcURLJavaScriptPython

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

{
  "id": "interior-walls-paint",
  "name": "interior-walls-paint",
  "quoteType": "interior",
  "label": "Interior Wall Painting",
  "clientLabel": "Wall Painting",
  "custom": false,
  "rateType": "sqftWalls",
  "calculationType": "amountPerHour",
  "rateSection": "painting",
  "defaultApps": 2,
  "maxApps": 3,
  "reportText": "Interior wall painting with premium paint",
  "areaReportText": "Wall painting",
  "values": [
    0.15,
    0.12,
    0.1,
    0.08
  ],
  "caption": "Per square foot",
  "useApps": true,
  "active": true,
  "coverage": "400 sqft per gallon",
  "hourlyRate": 65,
  "overrideHourlyRate": false
}

{
  "errors": [
    "Bad Request"
  ]
}

Retrieve Rate

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate

Responses

200

Details about the rate

application/json

idstringRequired

The unique ID of the rate.

namestringRequired

The unique name of the rate (same as id).

quoteTypestringOptional

The quote type this rate applies to

labelstringRequired

The display label of the rate.

clientLabelstringOptional

The label shown to clients

custombooleanOptional

Whether this is a custom rate

rateTypestringRequired

The type of rate calculation (e.g., sqftWalls, lnft, etc.)

calculationTypestringRequired

How the rate is calculated (e.g., amountPerHour)

rateSectionstringRequired

The rate category/section this rate belongs to

defaultAppsnumberOptional

Default number of applications/coats

maxAppsnumberOptional

Maximum possible applications/coats

reportTextstringOptional

Text shown in reports

areaReportTextstringOptional

Text shown in area reports

valuesnumber[]Required

Array of rate values for different applications

captionstringOptional

Caption or description for the rate

useAppsbooleanOptional

Whether this rate uses coat/application calculations

activebooleanOptional

Whether this rate is active & usable

coveragestringOptional

Coverage information or notes

hourlyRatenumberOptional

Hourly rate if applicable

overrideHourlyRatebooleanOptional

Whether this rate overrides the default hourly rate

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/rates/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "interior-walls-paint",
  "name": "interior-walls-paint",
  "quoteType": "interior",
  "label": "Interior Wall Painting",
  "clientLabel": "Wall Painting",
  "custom": false,
  "rateType": "sqftWalls",
  "calculationType": "amountPerHour",
  "rateSection": "painting",
  "defaultApps": 2,
  "maxApps": 3,
  "reportText": "Interior wall painting with premium paint",
  "areaReportText": "Wall painting",
  "values": [
    0.15,
    0.12,
    0.1,
    0.08
  ],
  "caption": "Per square foot",
  "useApps": true,
  "active": true,
  "coverage": "400 sqft per gallon",
  "hourlyRate": 65,
  "overrideHourlyRate": false
}

Update Rate

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate

Body

application/json

idstringRequired

The unique ID of the rate.

namestringRequired

The unique name of the rate (same as id).

quoteTypestringOptional

The quote type this rate applies to

labelstringRequired

The display label of the rate.

clientLabelstringOptional

The label shown to clients

custombooleanOptional

Whether this is a custom rate

rateTypestringRequired

The type of rate calculation (e.g., sqftWalls, lnft, etc.)

calculationTypestringRequired

How the rate is calculated (e.g., amountPerHour)

rateSectionstringRequired

The rate category/section this rate belongs to

defaultAppsnumberOptional

Default number of applications/coats

maxAppsnumberOptional

Maximum possible applications/coats

reportTextstringOptional

Text shown in reports

areaReportTextstringOptional

Text shown in area reports

valuesnumber[]Required

Array of rate values for different applications

captionstringOptional

Caption or description for the rate

useAppsbooleanOptional

Whether this rate uses coat/application calculations

activebooleanOptional

Whether this rate is active & usable

coveragestringOptional

Coverage information or notes

hourlyRatenumberOptional

Hourly rate if applicable

overrideHourlyRatebooleanOptional

Whether this rate overrides the default hourly rate

Responses

400

Bad Request

application/json

errorsstring[]Optional

Array of error messages

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

501

Not Implemented - Rate updates require complex document operations

application/json

put/settings/rates/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "interior-walls-paint",
  "name": "interior-walls-paint",
  "quoteType": "interior",
  "label": "Interior Wall Painting",
  "clientLabel": "Wall Painting",
  "custom": false,
  "rateType": "sqftWalls",
  "calculationType": "amountPerHour",
  "rateSection": "painting",
  "defaultApps": 2,
  "maxApps": 3,
  "reportText": "Interior wall painting with premium paint",
  "areaReportText": "Wall painting",
  "values": [
    0.15,
    0.12,
    0.1,
    0.08
  ],
  "caption": "Per square foot",
  "useApps": true,
  "active": true,
  "coverage": "400 sqft per gallon",
  "hourlyRate": 65,
  "overrideHourlyRate": false
}

{
  "errors": [
    "Bad Request"
  ]
}

Delete Rate

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Rate

Responses

400

Bad Request

application/json

errorsstring[]Optional

Array of error messages

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

501

Not Implemented - Rate deletion requires complex document operations

application/json

delete/settings/rates/{id}

HTTPcURLJavaScriptPython

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

{
  "errors": [
    "Bad Request"
  ]
}