Update Quote

PATCH

https://api.coperniq.io/v1/quotes/:quote_id

PATCH

/v1/quotes/:quote_id

1 const url = 'https://api.coperniq.io/v1/quotes/quote_id';
2 const options = {
3   method: 'PATCH',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": 1,
3   "status": "DRAFT",
4   "amount": 1.1,
5   "createdAt": "2024-01-15T09:30:00Z",
6   "updatedAt": "2024-01-15T09:30:00Z",
7   "quoteNumber": 1,
8   "description": "string",
9   "discountType": "PERCENTAGE",
10   "discountValue": 1.1,
11   "taxId": 1,
12   "issueDate": "2024-01-15T09:30:00Z",
13   "subtotal": 1.1,
14   "taxRate": 1.1,
15   "isArchived": true,
16   "sharedWithPortal": true,
17   "account": {
18     "id": 1,
19     "title": "string"
20   },
21   "record": {
22     "id": 1,
23     "title": "string",
24     "type": "string"
25   },
26   "lineItems": [
27     {
28       "id": 1,
29       "quantity": 1,
30       "unitCost": 1.1,
31       "unitPrice": 1.1,
32       "description": "string",
33       "totalCost": 1.1,
34       "totalPrice": 1.1,
35       "sectionName": "string",
36       "catalogItem": {
37         "id": 1,
38         "name": "string",
39         "sku": "string",
40         "type": "string",
41         "manufacturer": "string"
42       }
43     }
44   ]
45 }

Update an existing quote. Supports partial updates.

isArchived: pass true to archive or false to unarchive.

When setting status to anything other than DRAFT, you must supply issueDate unless the quote already has one.

sharedWithPortal: pass true or false to show or hide the quote on the client portal.

Update an existing quote. Supports partial updates. **`isArchived`**: pass `true` to archive or `false` to unarchive. When setting **`status`** to anything other than **`DRAFT`**, you must supply **`issueDate`** unless the quote already has one. **`sharedWithPortal`**: pass `true` or `false` to show or hide the quote on the client portal.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

quote_idstringRequired

Request

This endpoint expects an object.

sectionslist of objectsOptional

lineItemslist of objectsOptional

discountTypeenumOptional

discountValuedoubleOptional>=0

taxIdinteger or nullOptional

issueDatestringOptionalformat: "date-time"

statusenumOptional

descriptionstring or nullOptional

sharedWithPortalbooleanOptional

When true, the quote is visible on the client portal; when false, it is hidden.

isArchivedbooleanOptional

Set true to archive or false to unarchive (maps to payment service archive/unarchive routes)

Response

Quote updated successfully

idinteger

Quote identifier

statusenum

Quote status

amountdouble

Total quote amount (dollars)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

quoteNumberinteger or nullOptional

Unique quote number (uid)

descriptionstring or nullOptional

Quote description

discountTypeenum or nullOptional

Discount type

discountValuedouble or nullOptional

Discount amount or percentage value

taxIdinteger or nullOptional

Tax configuration ID

issueDatestring or nullOptionalformat: "date-time"

Issue date when the quote has been issued

subtotaldouble or nullOptional

Subtotal in dollars (before tax)

taxRatedouble or nullOptional

Applied tax rate

isArchivedbooleanOptional

Whether the quote is archived

sharedWithPortalbooleanOptional

Whether the quote is shared with the client portal

accountobject or nullOptional

recordobject or nullOptional

lineItemslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error