> For the complete documentation index, see [llms.txt](https://help.paintscout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.paintscout.com/developers/settings-rates.md).

# Settings Rates

## List Rates

> Lists rates. Pricing formulas (e.g. price per sqft of wall, 2 coats) applied per line item when building a quote, grouped under a rate category. Listing is not currently implemented; returns 501.

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Rate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the rate."},"name":{"type":"string","description":"The unique name of the rate (same as id)."},"quoteType":{"type":"string","description":"The quote type this rate applies to"},"label":{"type":"string","description":"The display label of the rate."},"clientLabel":{"type":"string","description":"The label shown to clients"},"custom":{"type":"boolean","description":"Whether this is a custom rate"},"rateType":{"type":"string","description":"The type of rate calculation (e.g., sqftWalls, lnft, etc.)"},"calculationType":{"type":"string","description":"How the rate is calculated (e.g., amountPerHour)"},"rateSection":{"type":"string","description":"The rate category/section this rate belongs to"},"defaultApps":{"type":"number","description":"Default number of applications/coats"},"maxApps":{"type":"number","description":"Maximum possible applications/coats"},"reportText":{"type":"string","description":"Text shown in reports"},"areaReportText":{"type":"string","description":"Text shown in area reports"},"values":{"type":"array","items":{"type":"number"},"description":"Array of rate values for different applications"},"caption":{"type":"string","description":"Caption or description for the rate"},"useApps":{"type":"boolean","description":"Whether this rate uses coat/application calculations"},"defaultProduct":{"type":"string","description":"Key of the legacy single default product for this rate, if set"},"defaultProducts":{"type":"array","description":"Default products applied by this rate. Each productKey references a product from /settings/products.","items":{"type":"object","additionalProperties":false,"properties":{"productKey":{"type":"string","description":"The id of the product from /settings/products"},"unitLabel":{"type":"string","description":"The unit the product is measured in for this rate"},"coverage":{"type":"string","description":"Coverage of this product for this rate"}},"required":["productKey"]}},"active":{"type":"boolean","description":"Whether this rate is active & usable"},"coverage":{"type":"string","description":"Coverage information or notes"},"hourlyRate":{"type":"number","description":"Hourly rate if applicable"},"overrideHourlyRate":{"type":"boolean","description":"Whether this rate overrides the default hourly rate"}},"required":["id","name","label","rateType","calculationType","rateSection","values"]},"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/settings/rates":{"get":{"summary":"List Rates","description":"Lists rates. Pricing formulas (e.g. price per sqft of wall, 2 coats) applied per line item when building a quote, grouped under a rate category. Listing is not currently implemented; returns 501.","operationId":"listRates","tags":["Settings - Rates"],"parameters":[{"name":"quoteType","in":"query","description":"Only return rates for this quote type. Rates that apply to every quote type are always returned.","required":false,"schema":{"type":"string"}},{"name":"rateSection","in":"query","description":"Only return rates in this rate category (see /settings/rateCategories)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of rates","content":{"application/json":{"schema":{"type":"object","properties":{"totalRows":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/Rate"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Not Implemented - Rate listing requires complex document operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## POST /settings/rates

> Create Rate

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Rate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the rate."},"name":{"type":"string","description":"The unique name of the rate (same as id)."},"quoteType":{"type":"string","description":"The quote type this rate applies to"},"label":{"type":"string","description":"The display label of the rate."},"clientLabel":{"type":"string","description":"The label shown to clients"},"custom":{"type":"boolean","description":"Whether this is a custom rate"},"rateType":{"type":"string","description":"The type of rate calculation (e.g., sqftWalls, lnft, etc.)"},"calculationType":{"type":"string","description":"How the rate is calculated (e.g., amountPerHour)"},"rateSection":{"type":"string","description":"The rate category/section this rate belongs to"},"defaultApps":{"type":"number","description":"Default number of applications/coats"},"maxApps":{"type":"number","description":"Maximum possible applications/coats"},"reportText":{"type":"string","description":"Text shown in reports"},"areaReportText":{"type":"string","description":"Text shown in area reports"},"values":{"type":"array","items":{"type":"number"},"description":"Array of rate values for different applications"},"caption":{"type":"string","description":"Caption or description for the rate"},"useApps":{"type":"boolean","description":"Whether this rate uses coat/application calculations"},"defaultProduct":{"type":"string","description":"Key of the legacy single default product for this rate, if set"},"defaultProducts":{"type":"array","description":"Default products applied by this rate. Each productKey references a product from /settings/products.","items":{"type":"object","additionalProperties":false,"properties":{"productKey":{"type":"string","description":"The id of the product from /settings/products"},"unitLabel":{"type":"string","description":"The unit the product is measured in for this rate"},"coverage":{"type":"string","description":"Coverage of this product for this rate"}},"required":["productKey"]}},"active":{"type":"boolean","description":"Whether this rate is active & usable"},"coverage":{"type":"string","description":"Coverage information or notes"},"hourlyRate":{"type":"number","description":"Hourly rate if applicable"},"overrideHourlyRate":{"type":"boolean","description":"Whether this rate overrides the default hourly rate"}},"required":["id","name","label","rateType","calculationType","rateSection","values"]},"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/settings/rates":{"post":{"summary":"Create Rate","operationId":"createRate","tags":["Settings - Rates"],"requestBody":{"description":"Data for creating a new rate","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rate"}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Not Implemented - Rate creation requires complex document operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Retrieve Rate

> Retrieves a single rate by ID. Pricing formulas (e.g. price per sqft of wall, 2 coats) applied per line item when building a quote, grouped under a rate category. Not currently implemented for individual retrieval; returns 501.

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Rate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the rate."},"name":{"type":"string","description":"The unique name of the rate (same as id)."},"quoteType":{"type":"string","description":"The quote type this rate applies to"},"label":{"type":"string","description":"The display label of the rate."},"clientLabel":{"type":"string","description":"The label shown to clients"},"custom":{"type":"boolean","description":"Whether this is a custom rate"},"rateType":{"type":"string","description":"The type of rate calculation (e.g., sqftWalls, lnft, etc.)"},"calculationType":{"type":"string","description":"How the rate is calculated (e.g., amountPerHour)"},"rateSection":{"type":"string","description":"The rate category/section this rate belongs to"},"defaultApps":{"type":"number","description":"Default number of applications/coats"},"maxApps":{"type":"number","description":"Maximum possible applications/coats"},"reportText":{"type":"string","description":"Text shown in reports"},"areaReportText":{"type":"string","description":"Text shown in area reports"},"values":{"type":"array","items":{"type":"number"},"description":"Array of rate values for different applications"},"caption":{"type":"string","description":"Caption or description for the rate"},"useApps":{"type":"boolean","description":"Whether this rate uses coat/application calculations"},"defaultProduct":{"type":"string","description":"Key of the legacy single default product for this rate, if set"},"defaultProducts":{"type":"array","description":"Default products applied by this rate. Each productKey references a product from /settings/products.","items":{"type":"object","additionalProperties":false,"properties":{"productKey":{"type":"string","description":"The id of the product from /settings/products"},"unitLabel":{"type":"string","description":"The unit the product is measured in for this rate"},"coverage":{"type":"string","description":"Coverage of this product for this rate"}},"required":["productKey"]}},"active":{"type":"boolean","description":"Whether this rate is active & usable"},"coverage":{"type":"string","description":"Coverage information or notes"},"hourlyRate":{"type":"number","description":"Hourly rate if applicable"},"overrideHourlyRate":{"type":"boolean","description":"Whether this rate overrides the default hourly rate"}},"required":["id","name","label","rateType","calculationType","rateSection","values"]},"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/settings/rates/{id}":{"get":{"summary":"Retrieve Rate","description":"Retrieves a single rate by ID. Pricing formulas (e.g. price per sqft of wall, 2 coats) applied per line item when building a quote, grouped under a rate category. Not currently implemented for individual retrieval; returns 501.","operationId":"getRate","tags":["Settings - Rates"],"parameters":[{"name":"id","in":"path","description":"ID of the Rate","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details about the rate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rate"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Not Implemented - Individual rate retrieval requires complex document operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## PUT /settings/rates/{id}

> Update Rate

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Rate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the rate."},"name":{"type":"string","description":"The unique name of the rate (same as id)."},"quoteType":{"type":"string","description":"The quote type this rate applies to"},"label":{"type":"string","description":"The display label of the rate."},"clientLabel":{"type":"string","description":"The label shown to clients"},"custom":{"type":"boolean","description":"Whether this is a custom rate"},"rateType":{"type":"string","description":"The type of rate calculation (e.g., sqftWalls, lnft, etc.)"},"calculationType":{"type":"string","description":"How the rate is calculated (e.g., amountPerHour)"},"rateSection":{"type":"string","description":"The rate category/section this rate belongs to"},"defaultApps":{"type":"number","description":"Default number of applications/coats"},"maxApps":{"type":"number","description":"Maximum possible applications/coats"},"reportText":{"type":"string","description":"Text shown in reports"},"areaReportText":{"type":"string","description":"Text shown in area reports"},"values":{"type":"array","items":{"type":"number"},"description":"Array of rate values for different applications"},"caption":{"type":"string","description":"Caption or description for the rate"},"useApps":{"type":"boolean","description":"Whether this rate uses coat/application calculations"},"defaultProduct":{"type":"string","description":"Key of the legacy single default product for this rate, if set"},"defaultProducts":{"type":"array","description":"Default products applied by this rate. Each productKey references a product from /settings/products.","items":{"type":"object","additionalProperties":false,"properties":{"productKey":{"type":"string","description":"The id of the product from /settings/products"},"unitLabel":{"type":"string","description":"The unit the product is measured in for this rate"},"coverage":{"type":"string","description":"Coverage of this product for this rate"}},"required":["productKey"]}},"active":{"type":"boolean","description":"Whether this rate is active & usable"},"coverage":{"type":"string","description":"Coverage information or notes"},"hourlyRate":{"type":"number","description":"Hourly rate if applicable"},"overrideHourlyRate":{"type":"boolean","description":"Whether this rate overrides the default hourly rate"}},"required":["id","name","label","rateType","calculationType","rateSection","values"]},"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/settings/rates/{id}":{"put":{"summary":"Update Rate","operationId":"updateRate","tags":["Settings - Rates"],"parameters":[{"name":"id","in":"path","description":"ID of the Rate","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated rate data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rate"}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Not Implemented - Rate updates require complex document operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## DELETE /settings/rates/{id}

> Delete Rate

```json
{"openapi":"3.0.0","info":{"title":"Core API","version":"v2"},"servers":[{"url":"https://openapi.paintscout.com/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Error":{"type":"object","additionalProperties":false,"properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Array of error messages"}}}}},"paths":{"/settings/rates/{id}":{"delete":{"summary":"Delete Rate","operationId":"deleteRate","tags":["Settings - Rates"],"parameters":[{"name":"id","in":"path","description":"ID of the Rate","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Not Implemented - Rate deletion requires complex document operations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.paintscout.com/developers/settings-rates.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.