Settings Line Items

List Line Item Options

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of line items

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/lineItems

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

{
  "totalRows": 1,
  "rows": [
    {
      "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
      "active": true,
      "label": "My Great Line Item",
      "description": "This is an example line item",
      "crewNote": "This is a note that would show to the crew",
      "clientNote": "This is a note that would show only to the client",
      "calculateBy": "quantity",
      "quantity": 5,
      "hours": 30.5,
      "pricePerUnit": 150,
      "price": 900
    }
  ]
}

Create Line Item

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

labelstringRequired

The label of the line item

descriptionstringOptional

The description of the line item.

unitstringOptional

The unit type (hour, sqft, etc).

ratenumberOptional

The rate for this line item.

activebooleanOptional

Whether this line item is active & usable

crewNotestringOptional

The crew note of the line item

clientNotestringOptional

The client note of the line item

calculateBystring · enumOptional

The calculation type of this line item

Possible values:

quantitynumberOptional

The quantity use if this is a quantity calculated line item

hoursnumberOptional

The hours of this line item

hourlyRatenumberOptional

The hourly rate used if using an hourly-rate based calculation

pricePerUnitnumberOptional

The price per unit if using a quantity-based calculation

pricenumberOptional

The price of this line item

Responses

200

Details about the new line item

application/json

idstringRequired

The unique ID of the line item.

activebooleanOptional

Whether this line item is active & usable

labelstringOptional

The label of the line item

descriptionstringOptional

The description of the line item

crewNotestringOptional

The crew note of the line item

clientNotestringOptional

The client note of the line item

calculateBystring · enumOptional

The calculation type of this line item

Possible values:

quantitynumberOptional

The quantity use if this is a quantity calculated line item

hoursnumberOptional

The hours of this line item

hourlyRatenumberOptional

The hourly rate used if using an hourly-rate based calculation

pricePerUnitnumberOptional

The price per unit if using a quantity-based calculation

pricenumberOptional

The price of this line item

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/settings/lineItems

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

{
  "label": "Test Line Item",
  "description": "Test line item template",
  "unit": "hour",
  "rate": 45
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "active": true,
  "label": "My Great Line Item",
  "description": "This is an example line item",
  "crewNote": "This is a note that would show to the crew",
  "clientNote": "This is a note that would show only to the client",
  "calculateBy": "quantity",
  "quantity": 5,
  "hours": 30.5,
  "pricePerUnit": 150,
  "price": 900
}

Retrieve Line Item

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the line item

Responses

200

Details about the line item

application/json

idstringRequired

The unique ID of the line item.

activebooleanOptional

Whether this line item is active & usable

labelstringOptional

The label of the line item

descriptionstringOptional

The description of the line item

crewNotestringOptional

The crew note of the line item

clientNotestringOptional

The client note of the line item

calculateBystring · enumOptional

The calculation type of this line item

Possible values:

quantitynumberOptional

The quantity use if this is a quantity calculated line item

hoursnumberOptional

The hours of this line item

hourlyRatenumberOptional

The hourly rate used if using an hourly-rate based calculation

pricePerUnitnumberOptional

The price per unit if using a quantity-based calculation

pricenumberOptional

The price of this line item

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/lineItems/{id}

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "active": true,
  "label": "My Great Line Item",
  "description": "This is an example line item",
  "crewNote": "This is a note that would show to the crew",
  "clientNote": "This is a note that would show only to the client",
  "calculateBy": "quantity",
  "quantity": 5,
  "hours": 30.5,
  "pricePerUnit": 150,
  "price": 900
}

Update Line Item

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Line Item

Body

idstringRequired

The unique ID of the line item.

activebooleanOptional

Whether this line item is active & usable

labelstringOptional

The label of the line item

descriptionstringOptional

The description of the line item

crewNotestringOptional

The crew note of the line item

clientNotestringOptional

The client note of the line item

calculateBystring · enumOptional

The calculation type of this line item

Possible values:

quantitynumberOptional

The quantity use if this is a quantity calculated line item

hoursnumberOptional

The hours of this line item

hourlyRatenumberOptional

The hourly rate used if using an hourly-rate based calculation

pricePerUnitnumberOptional

The price per unit if using a quantity-based calculation

pricenumberOptional

The price of this line item

Responses

200

Successfully updated line item

application/json

idstringRequired

The unique ID of the line item.

activebooleanOptional

Whether this line item is active & usable

labelstringOptional

The label of the line item

descriptionstringOptional

The description of the line item

crewNotestringOptional

The crew note of the line item

clientNotestringOptional

The client note of the line item

calculateBystring · enumOptional

The calculation type of this line item

Possible values:

quantitynumberOptional

The quantity use if this is a quantity calculated line item

hoursnumberOptional

The hours of this line item

hourlyRatenumberOptional

The hourly rate used if using an hourly-rate based calculation

pricePerUnitnumberOptional

The price per unit if using a quantity-based calculation

pricenumberOptional

The price of this line item

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/lineItems/{id}

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "active": true,
  "label": "My Great Line Item",
  "description": "This is an example line item",
  "crewNote": "This is a note that would show to the crew",
  "clientNote": "This is a note that would show only to the client",
  "calculateBy": "quantity",
  "quantity": 5,
  "hours": 30.5,
  "pricePerUnit": 150,
  "price": 900
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "active": true,
  "label": "My Great Line Item",
  "description": "This is an example line item",
  "crewNote": "This is a note that would show to the crew",
  "clientNote": "This is a note that would show only to the client",
  "calculateBy": "quantity",
  "quantity": 5,
  "hours": 30.5,
  "pricePerUnit": 150,
  "price": 900
}

Delete Line Item

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Line Item

Responses

204

Line item 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/lineItems/{id}

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

No content

Last updated 18 days ago

Was this helpful?