Get Opportunity Quotes

GET

https://api.coperniq.io/v1/opportunities/:opportunityId/quotes

GET

/v1/opportunities/:opportunityId/quotes

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

1 [
2   {
3     "id": 1,
4     "status": "DRAFT",
5     "amount": 1.1,
6     "createdAt": "2024-01-15T09:30:00Z",
7     "updatedAt": "2024-01-15T09:30:00Z",
8     "quoteNumber": 1,
9     "description": "string",
10     "discountType": "PERCENTAGE",
11     "discountValue": 1.1,
12     "taxId": 1,
13     "issueDate": "2024-01-15T09:30:00Z",
14     "subtotal": 1.1,
15     "taxRate": 1.1,
16     "isArchived": true,
17     "sharedWithPortal": true,
18     "account": {
19       "id": 1,
20       "title": "string"
21     },
22     "record": {
23       "id": 1,
24       "title": "string",
25       "type": "string"
26     },
27     "lineItems": [
28       {
29         "id": 1,
30         "quantity": 1,
31         "unitCost": 1.1,
32         "unitPrice": 1.1,
33         "description": "string",
34         "totalCost": 1.1,
35         "totalPrice": 1.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   }
47 ]

Retrieve quotes for a specific opportunity.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdintegerRequired

Opportunity ID

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

order_byenumOptionalDefaults to asc

Sort order for results

Allowed values:

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

Response

List of quotes for the opportunity

Errors

401

Unauthorized Error