Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
ProductCalculation

List product calculation line items V3

This endpoint requires the following scopes: productCalculation:read.

List a product purchase price calculation line items

get/api/v3/products/{id}/calculationItems

Path parameters

idstring required

Query parameters

key'archived' | 'designation' | 'costType' | 'includeInCalculation'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith'

operator

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

archived: equals, notEquals

designation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

costType: equals, notEquals, in, notIn

includeInCalculation: equals, notEquals

sortstring[]

Sort via id, -id, date, -date, designation, -designation, costType and -costType. Default sort is -id

perPageinteger
Example:15

Number of items per page. Default: 15, Max: 5000

pageinteger
Example:1

Page number. Only used with simple and table pagination.

cursorstring
Example:eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers

x-pagination'simple' | 'table' | 'cursor'
Example:simple

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Response

List a product purchase price calculation line items

OR
OR

Example response

{
  "data": [
    {
      "id": "33",
      "date": "2026-01-01",
      "costType": "purchase",
      "includeInCalculation": true,
      "totalCost": {
        "amount": "100.00",
        "currency": "EUR"
      },
      "forQuantity": 10,
      "costPerUnit": {
        "amount": "10.00",
        "currency": "EUR"
      },
      "purchaseOrder": {
        "id": "1234"
      },
      "editor": {
        "id": "17",
        "name": "JohnDoe"
      },
      "internalComment": "this is an internal comment"
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.example.com/items",
    "perPage": 15,
    "to": 15
  },
  "links": {
    "first": "https://api.example.com/items?page=1",
    "next": "https://api.example.com/items?page=17"
  }
}