Replace Project Line Items

const url = 'https://api.coperniq.io/v1/projects/1/line-items';
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "quantity": 1,
    "description": "string",
    "unitCost": 1.1,
    "totalCost": 1.1,
    "totalPrice": 1.1,
    "unitPrice": 1.1,
    "createdAt": "2024-01-15T09:30:00Z",
    "catalogItem": {
      "id": 1,
      "name": "string",
      "type": "PRODUCT",
      "manufacturer": "string",
      "sku": "string",
      "description": "string"
    },
    "sectionName": "string"
  }
]

Replace all line items for a project. Send an object with lineItems, sections, or both:

lineItems { lineItems: [...] } — ungrouped line items.
sections { sections: [{ name?, lineItems: [...] }] } — line items grouped into named sections.
The two may be combined (ungrouped items + named sections).

A catalogItemId may appear at most once across the flattened set.

Deprecated: the previous request shape is still accepted for backwards compatibility but is deprecated and will not be supported in a future version.

Replace all line items for a project. Send an object with `lineItems`, `sections`, or both: - **`lineItems`** `{ lineItems: [...] }` — ungrouped line items. - **`sections`** `{ sections: [{ name?, lineItems: [...] }] }` — line items grouped into named sections. - The two may be combined (ungrouped items + named sections). A `catalogItemId` may appear at most once across the flattened set. > **Deprecated:** the previous request shape is still accepted for backwards compatibility but is deprecated and will not be supported in a future version.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

projectIdintegerRequired

Project identifier

Request

This endpoint expects an object.

lineItemslist of objectsOptional

Ungrouped line items. May be combined with sections (a catalogItemId may appear only once across both).

sectionslist of objectsOptional

Line items grouped into named sections. May be combined with lineItems (ungrouped items).

Response

Updated list of line items

idinteger

Line item identifier

quantityinteger

Quantity of items

descriptionstring

Line item description

unitCostdouble

Cost per unit

totalCostdouble

Total cost (unitCost * quantity)

totalPricedouble

Total price (unitPrice * quantity)

unitPricedouble

Price per unit

createdAtstringformat: "date-time"

Creation timestamp

catalogItemobject

sectionNamestring or null

Section name; null when the item is ungrouped

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error