Ortslisten auflisten

Liefert eine paginierte Liste der in diesem Mandanten definierten Ortslisten.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

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-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.
Name
meal_allowance
Type
integer, nullable
Description
Class MealAllowance
Einer der Werte: 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-Felder

Name
id
Type
integer
Description
Eindeutige Kennung der Ortsliste.
Name
startdate
Type
string
Description
Datum, ab dem die Ortsliste gilt.
Name
enddate
Type
string, nullable
Description
Datum, bis zu dem die Ortsliste gilt.
Name
comments
Type
string, nullable
Description
Freitextkommentare zur Ortsliste.
Name
meal_allowance
Type
object
Description
Welche Verpflegungsmehraufwandsregelung für Einsatzorte dieser Liste gilt: keine, Deutschland, Österreich oder Österreich (24h).
Name
meal_allowance.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
meal_allowance.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "no meal allowance", "meal allowance germany", "meal allowance austria", "meal allowance austria 24 hours"
Name
locations
Type
Liste von Location
Description
Einsatzorte, die zu dieser Ortsliste gehören.
Name
locations.name
Type
string
Description
Name des Einsatzorts.
Name
locations.description
Type
string, nullable
Description
Freitextbeschreibung des Einsatzorts.
Name
locations.location_list_id
Type
integer
Description
Kennung der Ortsliste, zu der dieser Einsatzort gehört.
Name
locations.daily_rate_workday
Type
number, nullable
Description
Tagessatz für einen regulären Arbeitstag an diesem Einsatzort.
Name
locations.daily_rate_workday_taxed
Type
number, nullable
Description
Steuerpflichtiger Anteil des Tagessatzes für einen regulären Arbeitstag.
Name
locations.daily_rate_partial
Type
number, nullable
Description
Tagessatz für einen Teiltag an diesem Einsatzort.
Name
locations.daily_rate_fullday
Type
number, nullable
Description
Tagessatz für einen ganzen Abwesenheitstag an diesem Einsatzort.
Name
locations.daily_rate_fullday_taxed
Type
number, nullable
Description
Steuerpflichtiger Anteil des Tagessatzes für einen ganzen Abwesenheitstag.
Name
locations.rate_meal_flat
Type
number, nullable
Description
Verpflegungspauschale für diesen Einsatzort.
Name
locations.rate_breakfast_percent
Type
number, nullable
Description
Prozentsatz der Verpflegungspauschale, der bei gestelltem Frühstück abgezogen wird.
Name
locations.rate_breakfast_percent_taxed
Type
number, nullable
Description
Steuerpflichtiger Anteil des Frühstücksabzugs.
Name
locations.rate_lunch_percent
Type
number, nullable
Description
Prozentsatz der Verpflegungspauschale, der bei gestelltem Mittagessen abgezogen wird.
Name
locations.rate_lunch_percent_taxed
Type
number, nullable
Description
Steuerpflichtiger Anteil des Mittagessensabzugs.
Name
locations.rate_dinner_percent
Type
number, nullable
Description
Prozentsatz der Verpflegungspauschale, der bei gestelltem Abendessen abgezogen wird.
Name
locations.currency
Type
string, nullable
Description
Währung, in der die Sätze des Einsatzorts angegeben sind.
Name
locations.type
Type
object, nullable
Description
Ob es sich um eine reguläre Dienstreise oder eine andere Art von Dienstreise handelt.
Name
locations.inland
Type
boolean
Description
Ob der Einsatzort steuerlich als Inland gilt.
Name
locations.home_work_location
Type
boolean
Description
Ob dieser Einsatzort der reguläre Heimarbeitsort des Mitarbeiters ist.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Ortslisten GET Ortsliste abrufen