Create Quote | Coperniq API

Create a new quote on an opportunity (project/deal/account record).

opportunityId: Required — record ID used by the payment service.
sections or lineItems: At least one item required
discountType / discountValue: Optional discount
taxId: Optional tax
issueDate / status: issueDate only allowed with status of SENT or APPROVED

To add or replace line items on a work order, use PUT /work-orders/{workOrderId}/line-items instead.

Create a new quote on an opportunity (project/deal/account record). - `opportunityId`: Required — record ID used by the payment service. - `sections` or `lineItems`: At least one item required - `discountType` / `discountValue`: Optional discount - `taxId`: Optional tax - `issueDate` / `status`: `issueDate` only allowed with `status` of `SENT` or `APPROVED` To add or replace line items on a **work order**, use `PUT /work-orders/{workOrderId}/line-items` instead.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

opportunityIdintegerRequired>=1

Opportunity / project / account record ID

sectionslist of objectsOptional

Grouped line items. Required if lineItems is not provided.

lineItemslist of objectsOptional

Flat line items (grouped into one section automatically). Required if sections is not provided.

discountTypeenumOptional

Discount type

Allowed values:

discountValuedoubleOptional>=0

Discount amount or percentage

taxIdintegerOptional

Tax configuration ID

issueDatestringOptionalformat: "date-time"

Issue date. Requires status to be SENT or APPROVED.

statusenumOptional

Initial status (defaults to DRAFT)

Allowed values:

descriptionstring or nullOptional

titlestringOptional

Quote title (defaults to “Quote”)

servicePlanInstanceIdintegerOptional

siteIdintegerOptional

Response

Quote created successfully

idinteger

Quote identifier

statusenum

Quote status

Allowed values:

amountdouble

Total quote amount (dollars)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

quoteNumberinteger or null

Unique quote number (uid)

descriptionstring or null

Quote description

discountTypeenum or null

Discount type

Allowed values:

discountValuedouble or null

Discount amount or percentage value

taxIdinteger or null

Tax configuration ID

issueDatestring or nullformat: "date-time"

Issue date when the quote has been issued

subtotaldouble or null

Subtotal in dollars (before tax)

taxRatedouble or null

Applied tax rate

isArchivedboolean

Whether the quote is archived

sharedWithPortalboolean

Whether the quote is shared with the client portal

accountobject or null

recordobject or null

lineItemslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

1	const url = 'https://api.coperniq.io/v1/quotes';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"opportunityId":1}'
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	"sectionId": 1,
36	"sectionName": "string",
37	"catalogItem": {
38	"id": 1,
39	"name": "string",
40	"sku": "string",
41	"type": "string",
42	"manufacturer": "string"
43	}
44	}
45	]
46	}