Get Quote | Coperniq API

const url = 'https://api.coperniq.io/v1/quotes/quoteId';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "status": "DRAFT",
  "amount": 1.1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "quoteNumber": 1,
  "description": "string",
  "discountType": "PERCENTAGE",
  "discountValue": 1.1,
  "taxId": 1,
  "issueDate": "2024-01-15T09:30:00Z",
  "subtotal": 1.1,
  "taxRate": 1.1,
  "isArchived": true,
  "sharedWithPortal": true,
  "account": {
    "id": 1,
    "title": "string"
  },
  "record": {
    "id": 1,
    "title": "string",
    "type": "string"
  },
  "lineItems": [
    {
      "id": 1,
      "quantity": 1,
      "unitCost": 1.1,
      "unitPrice": 1.1,
      "description": "string",
      "totalCost": 1.1,
      "totalPrice": 1.1,
      "sectionId": 1,
      "sectionName": "string",
      "catalogItem": {
        "id": 1,
        "name": "string",
        "sku": "string",
        "type": "string",
        "manufacturer": "string"
      }
    }
  ]
}

Retrieve a specific quote by ID

Authentication

x-api-keystring

API Key authentication via header

Path parameters

quoteIdstringRequired

Response

Quote details

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

401

Unauthorized Error

404

Not Found Error