List price tables of a customer

Returns a paginated list of price tables assigned to the given customer.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/customers/{customer_number}/price-tables

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers/{customer_number}/price-tables' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

Name
customer_number
Type
string
Description
The customer customer number

Query parameters

Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "start_date": "2024-01-15T00:00:00.000000Z",
      "customer_number": "K-12345",
      "project_id": 16,
      "type": {
        "id": "string",
        "name": "Basispreistabelle"
      },
      "prices": [
        {
          "id": 1,
          "price_group": "Junior-Entwickler",
          "price": 1.5,
          "price_table_id": "string",
          "type": {
            "id": "string",
            "name": "Stundensatz"
          },
          "activity": "string",
          "ahr_factor": 1.5
        }
      ],
      "factors": [
        {
          "id": 1,
          "day": {
            "id": 1,
            "name": "So"
          },
          "start_time": "11:10:49",
          "end_time": "15:10:49",
          "factor": 1.5,
          "price_table_id": 1,
          "activity_id": 1
        }
      ]
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the price table.
Name
start_date
Type
string (date-time), nullable
Description
Date from which the price table applies.
Name
customer_number
Type
string, nullable
Description
Number of the customer this price table belongs to, for a customer-level price table.
Name
project_id
Type
integer, nullable
Description
Identifier of the project this price table belongs to, for a project-level price table.
Name
type
Type
object, nullable
Description
Whether the price table is scoped to a customer or a project.
Name
type.id
Type
string
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Basispreistabelle", "Project Price Table", "Customer Price Table"
Name
prices
Type
array of Price
Description
Prices defined in this price table.
Name
prices.id
Type
integer
Description
Unique identifier of the price.
Name
prices.price_group
Type
string
Description
Price group this price applies to.
Name
prices.price
Type
number
Description
The price amount.
Name
prices.price_table_id
Type
string
Description
Identifier of the price table this price belongs to.
Name
prices.type
Type
object, nullable
Description
Whether this price is an hourly rate, a daily rate, or a flat rate.
Name
prices.activity
Type
string, nullable
Description
Activity this price applies to, if it is scoped to a single activity.
Name
prices.ahr_factor
Type
number, nullable
Description
Hourly rate surcharge applied to this price. Only on instances with the MOD_3P extension. Not a generally available feature.
Name
factors
Type
array of PriceFactor
Description
Time-based factors defined in this price table, e.g. for night or weekend surcharges.
Name
factors.id
Type
integer
Description
Unique identifier of the price factor.
Name
factors.day
Type
object
Description
Day of the week this factor applies to.
Name
factors.start_time
Type
string (date-time), nullable
Description
Time of day from which this factor applies.
Name
factors.end_time
Type
string (date-time), nullable
Description
Time of day until which this factor applies.
Name
factors.factor
Type
number
Description
Multiplier applied to the price during this time window.
Name
factors.price_table_id
Type
integer
Description
Identifier of the price table this factor belongs to.
Name
factors.activity_id
Type
integer, nullable
Description
Identifier of the activity this factor is scoped to, if any.

Generated from the OpenAPI specification — edit the source code, not this page.

DELETE Delete a customer contact GET Get a price table of a customer