List locations

Returns a paginated list of the locations defined in this tenant, with their allowance rates.

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

Request

GET /api/v1/locations

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/locations' \
     --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
name[]
Type
array of string
Description
Name
location_list_id[]
Type
array of integer
Description
Name
home_work_location
Type
boolean, nullable
Description
Name
inland
Type
boolean, nullable
Description
Name
type
Type
integer, nullable
Description
Class BusinessTripType
One of: 0, 1
Name
currency[]
Type
array of string
Description

Response

{
  "data": [
    {
      "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
name
Type
string
Description
Name of the location.
Name
description
Type
string, nullable
Description
Free-text description of the location.
Name
location_list_id
Type
integer
Description
Identifier of the location list this location belongs to.
Name
daily_rate_workday
Type
number, nullable
Description
Daily rate for a regular workday at this location.
Name
daily_rate_workday_taxed
Type
number, nullable
Description
Taxable share of the daily rate for a regular workday.
Name
daily_rate_partial
Type
number, nullable
Description
Daily rate for a partial day at this location.
Name
daily_rate_fullday
Type
number, nullable
Description
Daily rate for a full day away at this location.
Name
daily_rate_fullday_taxed
Type
number, nullable
Description
Taxable share of the daily rate for a full day away.
Name
rate_meal_flat
Type
number, nullable
Description
Flat meal allowance for this location.
Name
rate_breakfast_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for breakfast provided.
Name
rate_breakfast_percent_taxed
Type
number, nullable
Description
Taxable share of the breakfast deduction.
Name
rate_lunch_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for lunch provided.
Name
rate_lunch_percent_taxed
Type
number, nullable
Description
Taxable share of the lunch deduction.
Name
rate_dinner_percent
Type
number, nullable
Description
Percentage of the meal allowance deducted for dinner provided.
Name
currency
Type
string, nullable
Description
Currency the location’s rates are expressed in.
Name
type
Type
object, nullable
Description
Whether this is a regular business trip or another kind of business trip.
Name
type.id
Type
integer
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: "Regular business trip", "Other business trip"
Name
inland
Type
boolean
Description
Whether the location counts as domestic (inland) for tax purposes.
Name
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.

Locations GET Get a location