Get Quote

GET

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

GET

/v1/quotes/:quote_id

1 const url = 'https://api.coperniq.io/v1/quotes/quote_id';
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   "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 }

Retrieve a specific quote by ID

Authentication

x-api-keystring

API Key authentication via header

Path parameters

quote_idstringRequired

Response

Quote details

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

401

Unauthorized Error

404

Not Found Error