Invoices

List Invoices

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32 · min: 1Optional

perPageinteger · int32 · min: 1 · max: 100Optional

querystringOptional

sortstringOptional

sortDirstring · enumOptionalPossible values:

workOrderbooleanOptional

Responses

200

List of invoices

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/invoices

HTTPcURLJavaScriptPython

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

{
  "totalRows": 1,
  "rows": [
    {
      "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
      "number": 234,
      "hourlyRate": 65.5
    }
  ]
}

Create Invoice

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

A unique ID for the Invoice. Ignored when creating & updating invoices.

numbernumberOptional

The Number of the Invoice

statusstring · nullableOptional

The status of this invoice

hourlyRatenumberOptional

The Hourly Rate of the Invoice

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead

parentQuoteIdstring · nullableOptional

The unique ID of the quote that this invoice was created from if available

parentQuoteNumbernumberOptional

The quote number of the quote that this invoice was created from if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this invoice

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this invoice

estimatorNotesstring · nullableOptional

The estimator notes associated with this invoice

clientNotestring · nullableOptional

The client note associated with this invoice

crewNotestring · nullableOptional

The crew note associated with this invoice

tagsstring[]Optional

Tags associated with this Invoice

Responses

200

Details about the new Invoice

application/json

idstringOptional

A unique ID for the Invoice. Ignored when creating & updating invoices.

numbernumberOptional

The Number of the Invoice

statusstring · nullableOptional

The status of this invoice

hourlyRatenumberOptional

The Hourly Rate of the Invoice

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead

parentQuoteIdstring · nullableOptional

The unique ID of the quote that this invoice was created from if available

parentQuoteNumbernumberOptional

The quote number of the quote that this invoice was created from if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this invoice

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this invoice

estimatorNotesstring · nullableOptional

The estimator notes associated with this invoice

clientNotestring · nullableOptional

The client note associated with this invoice

crewNotestring · nullableOptional

The crew note associated with this invoice

tagsstring[]Optional

Tags associated with this Invoice

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/invoices

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "number": 1,
  "status": "text",
  "hourlyRate": 1,
  "contact": {
    "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
    "firstName": "Bob",
    "lastName": "Johnson",
    "company": "Johnson Construction",
    "email": "[e-mail]",
    "phoneNumber": "5551234567"
  },
  "billingContact": {
    "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
    "firstName": "Bob",
    "lastName": "Johnson",
    "company": "Johnson Construction",
    "email": "[e-mail]",
    "phoneNumber": "5551234567"
  },
  "dates": {
    "quote": 1,
    "sent": 1,
    "viewed": 1,
    "accepted": 1,
    "declined": 1
  },
  "jobAddress": {
    "identifier": "text",
    "address": "text",
    "city": "text",
    "state": "text",
    "zip": "text"
  },
  "parentQuoteId": "text",
  "parentQuoteNumber": 1,
  "dealId": "text",
  "quoteType": {
    "id": "text",
    "label": "text"
  },
  "quoteTemplate": {
    "id": "text",
    "label": "text"
  },
  "items": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "totalAdjustment": {
    "rate": 1,
    "total": 1,
    "description": "text"
  },
  "discount": {
    "rate": 1,
    "total": 1,
    "description": "text"
  },
  "tax": {
    "rate": 1,
    "total": 1,
    "description": "text",
    "details": [
      {
        "rate": 1,
        "total": 1,
        "description": "text"
      }
    ]
  },
  "terms": "text",
  "estimatorNotes": "text",
  "clientNote": "text",
  "crewNote": "text",
  "totals": {
    "price": 1,
    "laborPrice": 1,
    "materialsPrice": 1,
    "additionalWorkLaborPrice": 1,
    "additionalWorkMaterialsPrice": 1,
    "afterAdjustment": 1,
    "afterDiscount": 1,
    "afterTax": 1,
    "hours": 1
  },
  "urls": {
    "invoice": "text",
    "workOrder": "text"
  },
  "source": {
    "id": "12345",
    "provider": "myOtherIntegratedApp"
  },
  "owner": {
    "id": "user123",
    "firstName": "Bob",
    "lastName": "Johnson",
    "title": "Project Manager",
    "email": "[e-mail]",
    "phoneNumber": "15551234567",
    "phoneExtension": "123"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890
  },
  "tags": [
    "text"
  ],
  "tagDetails": [
    {
      "name": "urgent",
      "label": "Urgent",
      "deleted": false,
      "updated": 1625247600
    }
  ]
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "number": 234,
  "hourlyRate": 65.5
}

Retrieve Invoice

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

Query parameters

displaystring · enumOptional

Display as either an Invoice or Work Order.

Default: quotePossible values:

langstring · enumOptional

Language used to locale-format Work Order values (only applies when display=work-order).

Default: enPossible values:

Responses

200

Details about the invoice

application/json

idstringOptional

A unique ID for the Invoice. Ignored when creating & updating invoices.

numbernumberOptional

The Number of the Invoice

statusstring · nullableOptional

The status of this invoice

hourlyRatenumberOptional

The Hourly Rate of the Invoice

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead

parentQuoteIdstring · nullableOptional

The unique ID of the quote that this invoice was created from if available

parentQuoteNumbernumberOptional

The quote number of the quote that this invoice was created from if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this invoice

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this invoice

estimatorNotesstring · nullableOptional

The estimator notes associated with this invoice

clientNotestring · nullableOptional

The client note associated with this invoice

crewNotestring · nullableOptional

The crew note associated with this invoice

tagsstring[]Optional

Tags associated with this Invoice

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/invoices/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "number": 234,
  "hourlyRate": 65.5
}

Update Invoice

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

Body

application/json

idstringOptional

A unique ID for the Invoice. Ignored when creating & updating invoices.

numbernumberOptional

The Number of the Invoice

statusstring · nullableOptional

The status of this invoice

hourlyRatenumberOptional

The Hourly Rate of the Invoice

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead

parentQuoteIdstring · nullableOptional

The unique ID of the quote that this invoice was created from if available

parentQuoteNumbernumberOptional

The quote number of the quote that this invoice was created from if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this invoice

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this invoice

estimatorNotesstring · nullableOptional

The estimator notes associated with this invoice

clientNotestring · nullableOptional

The client note associated with this invoice

crewNotestring · nullableOptional

The crew note associated with this invoice

tagsstring[]Optional

Tags associated with this Invoice

Responses

200

The updated invoice

application/json

idstringOptional

A unique ID for the Invoice. Ignored when creating & updating invoices.

numbernumberOptional

The Number of the Invoice

statusstring · nullableOptional

The status of this invoice

hourlyRatenumberOptional

The Hourly Rate of the Invoice

contactIdstring · nullableOptionalDeprecated

This field is deprecated. Use contact.id instead

parentQuoteIdstring · nullableOptional

The unique ID of the quote that this invoice was created from if available

parentQuoteNumbernumberOptional

The quote number of the quote that this invoice was created from if available

dealIdstring · nullableOptional

The unique ID of the deal associated with this invoice

quoteTypeIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteType.id instead

quoteTemplateIdstring · nullableOptionalDeprecated

This field is deprecated. Use quoteTemplate.id instead

termsstring · nullableOptional

The terms/contract associated with this invoice

estimatorNotesstring · nullableOptional

The estimator notes associated with this invoice

clientNotestring · nullableOptional

The client note associated with this invoice

crewNotestring · nullableOptional

The crew note associated with this invoice

tagsstring[]Optional

Tags associated with this Invoice

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/invoices/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "number": 1,
  "status": "text",
  "hourlyRate": 1,
  "contact": {
    "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
    "firstName": "Bob",
    "lastName": "Johnson",
    "company": "Johnson Construction",
    "email": "[e-mail]",
    "phoneNumber": "5551234567"
  },
  "billingContact": {
    "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
    "firstName": "Bob",
    "lastName": "Johnson",
    "company": "Johnson Construction",
    "email": "[e-mail]",
    "phoneNumber": "5551234567"
  },
  "dates": {
    "quote": 1,
    "sent": 1,
    "viewed": 1,
    "accepted": 1,
    "declined": 1
  },
  "jobAddress": {
    "identifier": "text",
    "address": "text",
    "city": "text",
    "state": "text",
    "zip": "text"
  },
  "parentQuoteId": "text",
  "parentQuoteNumber": 1,
  "dealId": "text",
  "quoteType": {
    "id": "text",
    "label": "text"
  },
  "quoteTemplate": {
    "id": "text",
    "label": "text"
  },
  "items": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "totalAdjustment": {
    "rate": 1,
    "total": 1,
    "description": "text"
  },
  "discount": {
    "rate": 1,
    "total": 1,
    "description": "text"
  },
  "tax": {
    "rate": 1,
    "total": 1,
    "description": "text",
    "details": [
      {
        "rate": 1,
        "total": 1,
        "description": "text"
      }
    ]
  },
  "terms": "text",
  "estimatorNotes": "text",
  "clientNote": "text",
  "crewNote": "text",
  "totals": {
    "price": 1,
    "laborPrice": 1,
    "materialsPrice": 1,
    "additionalWorkLaborPrice": 1,
    "additionalWorkMaterialsPrice": 1,
    "afterAdjustment": 1,
    "afterDiscount": 1,
    "afterTax": 1,
    "hours": 1
  },
  "urls": {
    "invoice": "text",
    "workOrder": "text"
  },
  "source": {
    "id": "12345",
    "provider": "myOtherIntegratedApp"
  },
  "owner": {
    "id": "user123",
    "firstName": "Bob",
    "lastName": "Johnson",
    "title": "Project Manager",
    "email": "[e-mail]",
    "phoneNumber": "15551234567",
    "phoneExtension": "123"
  },
  "timestamp": {
    "created": 1234567890,
    "updated": 1234567890
  },
  "tags": [
    "text"
  ],
  "tagDetails": [
    {
      "name": "urgent",
      "label": "Urgent",
      "deleted": false,
      "updated": 1625247600
    }
  ]
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "number": 234,
  "hourlyRate": 65.5
}

Delete Invoice

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

Responses

204

No Content

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/invoices/{id}

HTTPcURLJavaScriptPython

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

No content

List Invoice Items

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

Responses

200

List of invoice items

application/json

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/invoices/{id}/items

HTTPcURLJavaScriptPython

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

{
  "bid": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "options": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "archived": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "additionalWork": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ],
  "pending": [
    {
      "name": "Interior Wall Painting",
      "quoteType": "interior",
      "description": "Professional interior wall painting with premium paint",
      "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
      "price": 1245.5,
      "hours": 8.5,
      "quantity": 1,
      "crewNote": "Use Benjamin Moore paint from storage room",
      "clientNote": "Work will be completed during business hours",
      "files": [],
      "source": {
        "provider": "paintscout",
        "id": "rate-001",
        "value": "interior-walls",
        "label": "Interior Wall Painting Rate"
      }
    }
  ]
}

Create Invoice Item

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

Body

application/json

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

crewNotestringOptional

Notes for the crew working on this item

crewNoteHtmlstringOptional

HTML formatted notes for the crew

clientNotestringOptional

Notes visible to the client

clientNoteHtmlstringOptional

HTML formatted notes visible to the client

sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:

Responses

200

Details about the new Invoice Item

application/json

idstringOptional

Unique identifier for the invoice item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

crewNotestringOptional

Notes for the crew working on this item

crewNoteHtmlstringOptional

HTML formatted notes for the crew

clientNotestringOptional

Notes visible to the client

clientNoteHtmlstringOptional

HTML formatted notes visible to the client

sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/invoices/{id}/items

HTTPcURLJavaScriptPython

POST /v2/invoices/{id}/items HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "name": "Interior Wall Painting",
  "quoteType": "interior",
  "description": "Professional interior wall painting with premium paint",
  "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
  "price": 1245.5,
  "hours": 8.5,
  "quantity": 1,
  "crewNote": "Use Benjamin Moore paint from storage room",
  "clientNote": "Work will be completed during business hours",
  "files": [],
  "source": {
    "provider": "paintscout",
    "id": "rate-001",
    "value": "interior-walls",
    "label": "Interior Wall Painting Rate"
  }
}

{
  "name": "Interior Wall Painting",
  "quoteType": "interior",
  "description": "Professional interior wall painting with premium paint",
  "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
  "price": 1245.5,
  "hours": 8.5,
  "quantity": 1,
  "crewNote": "Use Benjamin Moore paint from storage room",
  "clientNote": "Work will be completed during business hours",
  "files": [],
  "source": {
    "provider": "paintscout",
    "id": "rate-001",
    "value": "interior-walls",
    "label": "Interior Wall Painting Rate"
  }
}

Get Invoice Item

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

itemIdstringRequired

ID of the Invoice Item

Responses

200

Details about the invoice item

application/json

idstringOptional

Unique identifier for the invoice item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

crewNotestringOptional

Notes for the crew working on this item

crewNoteHtmlstringOptional

HTML formatted notes for the crew

clientNotestringOptional

Notes visible to the client

clientNoteHtmlstringOptional

HTML formatted notes visible to the client

sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/invoices/{id}/items/{itemId}

HTTPcURLJavaScriptPython

GET /v2/invoices/{id}/items/{itemId} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "Interior Wall Painting",
  "quoteType": "interior",
  "description": "Professional interior wall painting with premium paint",
  "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
  "price": 1245.5,
  "hours": 8.5,
  "quantity": 1,
  "crewNote": "Use Benjamin Moore paint from storage room",
  "clientNote": "Work will be completed during business hours",
  "files": [],
  "source": {
    "provider": "paintscout",
    "id": "rate-001",
    "value": "interior-walls",
    "label": "Interior Wall Painting Rate"
  }
}

Update Invoice Item

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

itemIdstringRequired

ID of the Invoice Item

Body

application/json

namestringOptional

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberOptional

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

crewNotestringOptional

Notes for the crew working on this item

crewNoteHtmlstringOptional

HTML formatted notes for the crew

clientNotestringOptional

Notes visible to the client

clientNoteHtmlstringOptional

HTML formatted notes visible to the client

sectionstring · enumOptional

The section this item belongs to

Possible values:

Responses

200

Updated invoice item details

application/json

idstringOptional

Unique identifier for the invoice item

namestringRequired

The title/name for this item

quoteTypestringOptional

The quote type this item applies to

descriptionstringOptional

The plain text description for this item

descriptionHtmlstringOptional

The HTML formatted description for this item

pricenumberRequired

The total price for this item

hoursnumberOptional

The estimated hours for this item

quantitynumberOptional

The quantity of this item

pricePerUnitnumberOptional

The price per unit if quantity-based pricing

crewNotestringOptional

Notes for the crew working on this item

crewNoteHtmlstringOptional

HTML formatted notes for the crew

clientNotestringOptional

Notes visible to the client

clientNoteHtmlstringOptional

HTML formatted notes visible to the client

sectionstring · enumOptional

The section this item belongs to

Default: bidPossible values:

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/invoices/{id}/items/{itemId}

HTTPcURLJavaScriptPython

PUT /v2/invoices/{id}/items/{itemId} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "price": 1500,
  "quantity": 2,
  "description": "Updated description for the item",
  "crewNote": "Updated crew instructions"
}

{
  "name": "Interior Wall Painting",
  "quoteType": "interior",
  "description": "Professional interior wall painting with premium paint",
  "descriptionHtml": "<p>Professional interior wall painting with <strong>premium paint</strong></p>",
  "price": 1245.5,
  "hours": 8.5,
  "quantity": 1,
  "crewNote": "Use Benjamin Moore paint from storage room",
  "clientNote": "Work will be completed during business hours",
  "files": [],
  "source": {
    "provider": "paintscout",
    "id": "rate-001",
    "value": "interior-walls",
    "label": "Interior Wall Painting Rate"
  }
}

Delete Invoice Item

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Invoice

itemIdstringRequired

ID of the Invoice Item

Responses

204

Invoice 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/invoices/{id}/items/{itemId}

HTTPcURLJavaScriptPython

DELETE /v2/invoices/{id}/items/{itemId} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content