List location lists

Returns a paginated list of the location lists defined in this tenant.

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

Request

GET /api/v1/location-lists

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

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
meal_allowance
Type
integer, nullable
Description
Class MealAllowance
One of: 0, 1, 2, 3
Name
start_date_from
Type
string (date-time), nullable
Description
Name
start_date_to
Type
string (date-time), nullable
Description
Name
has_locations
Type
boolean, nullable
Description

Response

{
  "data": [
    {
      "id": 1,
      "startdate": "string",
      "enddate": "string",
      "comments": "Wichtiger Kunde - mit Sorgfalt behandeln",
      "meal_allowance": {
        "id": 1,
        "name": "no meal allowance"
      },
      "locations": [
        {
          "name": "EU",
          "description": "Angebot|en:offer",
          "location_list_id": 1,
          "daily_rate_workday": 1.5,
          "daily_rate_workday_taxed": 1.5,
          "daily_rate_partial": 1.5,
          "daily_rate_fullday": 1.5,
          "daily_rate_fullday_taxed": 1.5,
          "rate_meal_flat": 1.5,
          "rate_breakfast_percent": 1.5,
          "rate_breakfast_percent_taxed": 1.5,
          "rate_lunch_percent": 1.5,
          "rate_lunch_percent_taxed": 1.5,
          "rate_dinner_percent": 1.5,
          "currency": "EUR",
          "type": {
            "id": 1,
            "name": "Regular business trip"
          },
          "inland": true,
          "home_work_location": true
        }
      ]
    }
  ],
  "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 location list.
Name
startdate
Type
string
Description
Date from which the location list applies.
Name
enddate
Type
string, nullable
Description
Date until which the location list applies.
Name
comments
Type
string, nullable
Description
Free-text comments about the location list.
Name
meal_allowance
Type
object
Description
Which meal allowance regime applies to locations in this list: none, Germany, Austria, or Austria (24h).
Name
meal_allowance.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
meal_allowance.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "no meal allowance", "meal allowance germany", "meal allowance austria", "meal allowance austria 24 hours"
Name
locations
Type
array of Location
Description
Locations belonging to this location list.
Name
locations.name
Type
string
Description
Name of the location.
Name
locations.description
Type
string, nullable
Description
Free-text description of the location.
Name
locations.location_list_id
Type
integer
Description
Identifier of the location list this location belongs to.
Name
locations.daily_rate_workday
Type
number, nullable
Description
Daily rate for a regular workday at this location.
Name
locations.daily_rate_workday_taxed
Type
number, nullable
Description
Taxable share of the daily rate for a regular workday.
Name
locations.daily_rate_partial
Type
number, nullable
Description
Daily rate for a partial day at this location.
Name
locations.daily_rate_fullday
Type
number, nullable
Description
Daily rate for a full day away at this location.
Name
locations.daily_rate_fullday_taxed
Type
number, nullable
Description
Taxable share of the daily rate for a full day away.
Name
locations.rate_meal_flat
Type
number, nullable
Description
Flat meal allowance for this location.
Name
locations.rate_breakfast_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for breakfast provided.
Name
locations.rate_breakfast_percent_taxed
Type
number, nullable
Description
Taxable share of the breakfast deduction.
Name
locations.rate_lunch_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for lunch provided.
Name
locations.rate_lunch_percent_taxed
Type
number, nullable
Description
Taxable share of the lunch deduction.
Name
locations.rate_dinner_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for dinner provided.
Name
locations.currency
Type
string, nullable
Description
Currency the location’s rates are expressed in.
Name
locations.type
Type
object, nullable
Description
Whether this is a regular business trip or another kind of business trip.
Name
locations.inland
Type
boolean
Description
Whether the location counts as domestic (inland) for tax purposes.
Name
locations.home_work_location
Type
boolean
Description
Whether this location is the employee’s regular home work location.

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

Location Lists GET Get a location list