REST DokumentationProject EmployeesGET Projektzuordnungen aller Projekte auflisten

Projektzuordnungen aller Projekte auflisten

Liefert die paginierte Liste aller Projektzuordnungen des Mandanten, sodass ein Client sie nicht Projekt für Projekt oder Mitarbeiter für Mitarbeiter abrufen muss. Filtern Sie nach project_id und employee_id (ein Wert oder eine Liste), project_status, project_start_date und project_end_date. Die Zeilen sind nach id sortiert, sofern orderBy nichts anderes vorgibt.

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

Request

GET /api/v1/project-employees
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/project-employees' \
     --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
    project_status
    Type
    string, nullable
    Description

    Beschränkt das Ergebnis auf Projekte in einem oder mehreren Status. Sowohl ein einzelner Wert als auch eine Liste wird akzeptiert.

  • Name
    project_start_date
    Type
    string (date)
    Description

    Nur Projekte zurückgeben, deren Startdatum dieses Datum oder später ist.

  • Name
    project_end_date
    Type
    string (date)
    Description

    Nur Projekte zurückgeben, deren Enddatum an oder vor diesem Datum liegt. Darf nicht vor project_start_date liegen.

  • Name
    project_id[]
    Type
    Liste von integer
    Description

    Nur Zuordnungen zu diesen Projekten zurückgeben. Senden Sie eine ID (project_id=7) oder mehrere (project_id[]=7&project_id[]=8). Eine unbekannte ID ergibt eine leere Liste.

  • Name
    employee_id[]
    Type
    Liste von string
    Description

    Nur Zuordnungen dieser Mitarbeiter zurückgeben. Senden Sie einen Benutzernamen (employee_id=jdoe) oder mehrere (employee_id[]=jdoe&employee_id[]=asmith).

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "project_id": 16,
      "project_number": "P-1001",
      "from": "2025-01-01T00:00:00.000000Z",
      "to": "2025-12-31T00:00:00.000000Z",
      "note": "Familienurlaub",
      "availability": 100,
      "internal_rate": 1.5,
      "rate_type": {
        "id": 1,
        "name": "Hourly"
      },
      "type": {
        "id": 0,
        "name": "Project member"
      },
      "priceGroup": {
        "id": 1,
        "name": "EU",
        "number": "EU-1",
        "status": true,
        "description": {
          "de": "Preisgruppe EU",
          "en": "EU price group"
        }
      }
    }
  ],
  "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

    Die eindeutige Kennung der Zuordnung.

  • Name
    employee_id
    Type
    string
    Description

    Die Kennung des zugeordneten Mitarbeiters.

  • Name
    project_id
    Type
    integer
    Description

    Die Kennung des Projekts, zu dem die Zuordnung gehört.

  • Name
    project_number
    Type
    string, nullable
    Description

    Die Nummer des Projekts, zu dem die Zuordnung gehört; null, wenn das Projekt nicht mehr existiert.

  • Name
    from
    Type
    string (date-time), nullable
    Description

    Das Datum, ab dem die Zuordnung gilt.

  • Name
    to
    Type
    string (date-time), nullable
    Description

    Das Datum, bis zu dem die Zuordnung gilt.

  • Name
    note
    Type
    string, nullable
    Description

    Eine freie Notiz zur Zuordnung.

  • Name
    availability
    Type
    integer, nullable
    Description

    Wie viel der Zeit des Mitarbeiters für dieses Projekt zur Verfügung steht.

  • Name
    internal_rate
    Type
    number, nullable
    Description

    Der interne Stundensatz, der für die Zeit des Mitarbeiters im Projekt gilt.

  • Name
    rate_type
    Type
    object, nullable
    Description

    Wie der interne Satz angewendet wird: pro Stunde, pro Tag oder als Pauschale.

  • Name
    rate_type.id
    Type
    integer
    Description

    Der gespeicherte Wert. Vergleichen Sie damit, nicht mit name.

  • Name
    rate_type.name
    Type
    string
    Description

    Die lesbare Bezeichnung in der Sprache der Instanz. Nicht auswerten.

    Einer der Werte: "Hourly", "Täglich", "keines"

  • Name
    type
    Type
    object, nullable
    Description

    Die Position des Mitarbeiters im Projekt, z. B. Leitung oder Mitglied.

  • Name
    type.id
    Type
    integer
    Description

    Der gespeicherte Wert. Vergleichen Sie damit, nicht mit name.

  • Name
    type.name
    Type
    string
    Description

    Die lesbare Bezeichnung in der Sprache der Instanz. Nicht auswerten.

    Einer der Werte: "Project member", "Project manager with budget responsibility", "Projektleiter"

  • Name
    priceGroup
    Type
    object (PriceGroup)
    Description

    Die Preisgruppe, mit der der Mitarbeiter in diesem Projekt abgerechnet wird.

  • Name
    priceGroup.id
    Type
    integer
    Description

    Die eindeutige Kennung der Preisgruppe.

  • Name
    priceGroup.name
    Type
    string
    Description

    Der Name der Preisgruppe, wie er bei der Zuordnung zu einem Kunden oder Projekt angezeigt wird.

  • Name
    priceGroup.number
    Type
    string, nullable
    Description

    Die Nummer der Preisgruppe, die zur externen Referenzierung verwendet wird.

  • Name
    priceGroup.status
    Type
    boolean
    Description

    Ob die Preisgruppe aktiv ist; die zugrunde liegende Spalte wird invertiert gespeichert, true bedeutet hier aktiv.

  • Name
    priceGroup.description
    Type
    object
    Description

    Die Beschreibung der Preisgruppe, ausgegeben als sprachabhängige Struktur (i18n) statt als einfache Zeichenkette.

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