Projekte auflisten

Liefert eine paginierte Liste der Projekte, filterbar über die von diesem Endpunkt akzeptierten Query-Parameter.

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

Request

GET /api/v1/projects

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects' \
     --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
modified_after
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die vor oder zu diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
start_date
Type
string (date), nullable
Description
Name
end_date
Type
string (date), nullable
Description
Name
id[]
Type
Liste von string, nullable
Description
Name
status
Type
string, nullable
Description
Name
name
Type
string, nullable
Description
Name
search
Type
string, nullable
Description

Response

{
  "data": [
    {
      "id": 1,
      "name": "EU",
      "description": "Angebot|en:offer",
      "start_date": "2024-01-15T00:00:00.000000Z",
      "end_date": "2024-01-16T00:00:00.000000Z",
      "project_status_id": "aktiv",
      "status": {
        "id": 1,
        "name": "EU",
        "description": "Angebot|en:offer",
        "bookable": true,
        "order": 0,
        "color": "#664599",
        "abrechnungsrelevant": "string"
      },
      "comments": "Wichtiger Kunde - mit Sorgfalt behandeln",
      "cost_object": "string",
      "cost_object_identifier": "string",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z",
      "keywords": [
        null
      ],
      "reference_order": "string",
      "reference_commission": "string",
      "reference_procurement": "string",
      "reference_object": "string",
      "language": "de",
      "currency": "EUR",
      "url": "https://www.zep-online.de/zepinstanz/next/api/v1/articles?page=1",
      "location_address": "string",
      "location_city": "string",
      "location_state": "string",
      "location_country": "string",
      "revenue_account": "8400",
      "customer_id": "string",
      "customer_contact_id": "string",
      "customer_project_reference": "string",
      "customer_billing_address_id": "string",
      "customer_shipping_address_id": "string",
      "has_multiple_customers": true,
      "department_id": 1,
      "billing_type": {
        "id": 1,
        "name": "Stundensatz"
      },
      "billing_tasks": "string",
      "plan_hours": 1.5,
      "plan_hours_children": 1.5,
      "plan_hours_per_day": 1.5,
      "plan_can_exceed": {
        "id": 1,
        "name": "Yes, all times can exceed the plan hours"
      },
      "plan_warning_percent": 1.5,
      "plan_warning_percent_2": 1.5,
      "plan_warning_percent_3": 1.5,
      "plan_wage": 1.5,
      "plan_expenses": 1.5,
      "plan_expenses_travel": 1.5,
      "plan_hours_done": 1.5,
      "plan_hours_invoiced": 1.5,
      "default_billability": {
        "id": 1,
        "name": "Fakturierbar, durch den Mitarbeiter änderbar"
      },
      "receipts_billability": {
        "id": 1,
        "name": "Specify billable amount apart"
      },
      "plan_wage_children": 0,
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ],
      "dynamicAttributes": [
        {
          "name": "EU",
          "value": "Max Mustermann (Bruder)",
          "type": "Text",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          }
        }
      ],
      "categories_count": 0,
      "dynamicAttributes_count": 0,
      "tasks_count": 0,
      "employees_count": 0,
      "activities_count": 0,
      "priceTables": [
        {
          "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": {},
              "activity": "string",
              "ahr_factor": 1.5
            }
          ],
          "factors": [
            {
              "id": 1,
              "day": {},
              "start_time": "11:10:49",
              "end_time": "15:10:49",
              "factor": 1.5,
              "price_table_id": 1,
              "activity_id": 1
            }
          ]
        }
      ],
      "end_customer_number": "string"
    }
  ],
  "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 des Projekts.
Name
name
Type
string, nullable
Description
Name des Projekts.
Name
description
Type
string, nullable
Description
Freitext-Beschreibung des Projekts.
Name
start_date
Type
string (date-time), nullable
Description
Datum, an dem das Projekt beginnt.
Name
end_date
Type
string (date-time), nullable
Description
Datum, an dem das Projekt endet, sofern ein Ende festgelegt ist.
Name
project_status_id
Type
string
Description
Kennung des aktuellen Projektstatus.
Name
status
Type
object (ProjectStatus)
Description
Der aktuelle Status des Projekts, einschließlich seiner Bezeichnung und ob er abrechenbar ist.
Name
status.id
Type
integer
Description
Kennung des Status. Der Kurzname dient gleichzeitig als Primärschlüssel.
Name
status.name
Type
string
Description
Kurzname des Status, wie er in der Projektliste angezeigt wird.
Name
status.description
Type
string, nullable
Description
Längere Bezeichnung, die die Bedeutung des Status beschreibt.
Name
status.bookable
Type
boolean
Description
Ob auf ein Projekt mit diesem Status noch Zeiten gebucht werden können.
Name
status.order
Type
integer
Description
Sortierposition des Status in Auswahllisten.
Name
status.color
Type
string, nullable
Description
Farbe, in der der Status dargestellt wird, als Hex-Wert.
Name
status.abrechnungsrelevant
Type
string
Description
Ob Projekte mit diesem Status in Abrechnungsläufe einbezogen werden.
Name
comments
Type
string, nullable
Description
Interne Freitext-Kommentare zum Projekt.
Name
cost_object
Type
string, nullable
Description
Kostenstelle, der die Buchungen des Projekts für Buchhaltungszwecke zugeordnet werden.
Name
cost_object_identifier
Type
string, nullable
Description
Dem Projekt zugeordneter Kostenträger, eine von der Kostenstelle getrennte Buchhaltungsdimension, die für den Buchhaltungsexport verwendet wird.
Name
created
Type
string (date-time), nullable
Description
Datum und Uhrzeit der Erstellung des Projekts.
Name
modified
Type
string (date-time), nullable
Description
Datum und Uhrzeit der letzten Änderung des Projekts.
Name
keywords
Type
Liste von object
Description
Freitext-Schlagwörter zur Suche nach dem Projekt.
Name
reference_order
Type
string, nullable
Description
Bestellreferenz des Kunden für dieses Projekt.
Name
reference_commission
Type
string, nullable
Description
Kommissionsreferenz des Kunden für dieses Projekt.
Name
reference_procurement
Type
string, nullable
Description
Beschaffungsreferenz des Kunden für dieses Projekt.
Name
reference_object
Type
string, nullable
Description
Objektreferenz des Kunden für dieses Projekt.
Name
language
Type
string, nullable
Description
Sprache, die für Dokumente dieses Projekts verwendet wird.
Name
currency
Type
string, nullable
Description
Währung, die für Geldbeträge in diesem Projekt verwendet wird.
Name
url
Type
string, nullable
Description
Mit dem Projekt verknüpfte URL, zum Beispiel ein Link zu einem Kundenportal.
Name
location_address
Type
string, nullable
Description
Straße und Hausnummer des Projektstandorts.
Name
location_city
Type
string, nullable
Description
Ort des Projektstandorts.
Name
location_state
Type
string, nullable
Description
Bundesland oder Region des Projektstandorts.
Name
location_country
Type
string, nullable
Description
Land des Projektstandorts.
Name
revenue_account
Type
string, nullable
Description
Erlöskonto, auf das der Umsatz des Projekts gebucht wird.
Name
customer_id
Type
string, nullable
Description
Kennung des Kunden, zu dem dieses Projekt gehört.
Name
customer_contact_id
Type
string, nullable
Description
Kennung des für dieses Projekt verantwortlichen Ansprechpartners.
Name
customer_project_reference
Type
string, nullable
Description
Eigene Referenznummer des Kunden für dieses Projekt.
Name
customer_billing_address_id
Type
string, nullable
Description
Kennung der Kundenadresse, die für die Rechnungsstellung verwendet wird.
Name
customer_shipping_address_id
Type
string, nullable
Description
Kennung der Kundenadresse, die für den Versand verwendet wird.
Name
has_multiple_customers
Type
boolean, nullable
Description
Ob das Projekt an mehr als einen Kunden abgerechnet werden kann.
Name
department_id
Type
integer, nullable
Description
Kennung der Abteilung, der das Projekt zugeordnet ist.
Name
billing_type
Type
object, nullable
Description
Wie das Projekt abgerechnet wird: Stundensatz, Tagessatz oder Pauschale.
Name
billing_type.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
billing_type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Stundensatz", "Tagessatz", "Pausch"
Name
billing_tasks
Type
string, nullable
Description
Ob die Vorgänge des Projekts jeweils eine eigene Abrechnungsart haben können.
Name
plan_hours
Type
number, nullable
Description
Geplante Gesamtstunden, die für das Projekt budgetiert sind.
Name
plan_hours_children
Type
number, nullable
Description
Geplante Stunden, die über die Vorgänge des Projekts budgetiert sind.
Name
plan_hours_per_day
Type
number, nullable
Description
Geplante Stunden, die pro Tag für das Projekt budgetiert sind.
Name
plan_can_exceed
Type
object, nullable
Description
Ob erfasste Stunden das geplante Budget überschreiten dürfen: für alle Zeiten, nur für nicht abrechenbare Zeiten, gar nicht, nur für Reise- oder nicht abrechenbare Zeiten oder nur für Reisezeiten.
Name
plan_can_exceed.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
plan_can_exceed.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Yes, all times can exceed the plan hours", "Yes, but only non-billable times can exceed the plan hours", "No, all times can not exceed the plan hours", "Yes, but only travel or non-billable times can exceed the plan hours", "Yes, but only travel times can exceed the plan hours"
Name
plan_warning_percent
Type
number, nullable
Description
Prozentsatz des geplanten Budgets, bei dem eine Warnung ausgelöst wird.
Name
plan_warning_percent_2
Type
number, nullable
Description
Zweite Warnschwelle als Prozentsatz des geplanten Budgets.
Name
plan_warning_percent_3
Type
number, nullable
Description
Dritte Warnschwelle als Prozentsatz des geplanten Budgets.
Name
plan_wage
Type
number, nullable
Description
Geplante Gesamtlohnkosten, die für das Projekt budgetiert sind.
Name
plan_expenses
Type
number, nullable
Description
Geplante Gesamtausgaben, die für das Projekt budgetiert sind.
Name
plan_expenses_travel
Type
number, nullable
Description
Geplante Reisekosten, die für das Projekt budgetiert sind.
Name
plan_hours_done
Type
number, nullable
Description
Bereits auf das Projekt erfasste Stunden.
Name
plan_hours_invoiced
Type
number, nullable
Description
Bereits für das Projekt in Rechnung gestellte Stunden.
Name
default_billability
Type
object
Description
Standard-Abrechenbarkeit, die auf neue Zeiteinträge in diesem Projekt angewendet wird.
Name
default_billability.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
default_billability.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Fakturierbar, durch den Mitarbeiter änderbar", "Fakturierbar, durch den Mitarbeiter nicht änderbar", "Not billable, user can change the flag", "Not billable, user can not change the flag"
Name
receipts_billability
Type
object, nullable
Description
Standard-Abrechenbarkeit, die auf neue Belege in diesem Projekt angewendet wird.
Name
receipts_billability.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
receipts_billability.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Specify billable amount apart", "Vorbelegung identisch weiterfakturieren", "Vorbelegung nicht weiterfakturieren", "keine Belegerfassung möglich"
Name
plan_wage_children
Type
number, nullable
Description
Geplante Lohnkosten, die über die Vorgänge des Projekts budgetiert sind.
Name
categories
Type
Liste von Category
Description
Dem Projekt zugeordnete Kategorien.
Name
categories.name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
categories.description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
Name
categories.type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.
Name
dynamicAttributes
Type
Liste von DynamicAttribute
Description
Für das Projekt konfigurierte dynamische Attribute.
Name
dynamicAttributes.name
Type
string
Description
Name der Definition des dynamischen Attributs, für die dieser Wert eingegeben wurde.
Name
dynamicAttributes.value
Type
any
Description
Der gespeicherte Wert; seine Form hängt vom benachbarten Feld type ab (eine Zeichenkette, eine Zahl, ein Boolean, ein Datum, eine Mitarbeiterreferenz oder eine Liste von Optionswerten).
Name
dynamicAttributes.type
Type
string
Description
Datentyp dieses Attributs, z. B. Text, Zahl, Datum oder Optionen; bestimmt, wie value zu interpretieren ist.
Einer der Werte: "Text", "Integer", "Float", "URL", "E-Mail", "Datum", "Uhrzeit", "Datetime", "Boolean", "Betrag", "Optionen", "Prozent", "Time period", "Textarea", "Users", "Upload"
Name
dynamicAttributes.description
Type
object, nullable
Description
Erläuterung, was dieses Attribut erfasst, wie in seiner Definition konfiguriert.
Name
categories_count
Type
integer
Description
Anzahl der dem Projekt zugeordneten Kategorien.
Name
dynamicAttributes_count
Type
integer
Description
Anzahl der für das Projekt konfigurierten dynamischen Attribute.
Name
tasks_count
Type
integer
Description
Anzahl der zum Projekt gehörenden Vorgänge.
Name
employees_count
Type
integer
Description
Anzahl der dem Projekt zugeordneten Mitarbeiter.
Name
activities_count
Type
integer
Description
Anzahl der dem Projekt zugeordneten Tätigkeiten.
Name
priceTables
Type
Liste von PriceTable
Description
Dem Projekt zugeordnete Preistabellen. Nur enthalten, wenn sie an die Antwort angehängt werden.
Name
priceTables.id
Type
integer
Description
Eindeutige Kennung der Preistabelle.
Name
priceTables.start_date
Type
string (date-time), nullable
Description
Datum, ab dem die Preistabelle gilt.
Name
priceTables.customer_number
Type
string, nullable
Description
Nummer des Kunden, zu dem diese Preistabelle gehört, bei einer Preistabelle auf Kundenebene.
Name
priceTables.project_id
Type
integer, nullable
Description
Kennung des Projekts, zu dem diese Preistabelle gehört, bei einer Preistabelle auf Projektebene.
Name
priceTables.type
Type
object, nullable
Description
Ob die Preistabelle einem Kunden oder einem Projekt zugeordnet ist.
Name
priceTables.prices
Type
Liste von Price
Description
In dieser Preistabelle definierte Preise.
Name
priceTables.factors
Type
Liste von PriceFactor
Description
In dieser Preistabelle definierte zeitabhängige Faktoren, z. B. für Nacht- oder Wochenendzuschläge.
Name
end_customer_number
Type
string, nullable
Description
Die Nummer, unter der der Endkunde im eigenen System des Kunden geführt wird. Nur in Instanzen mit der Erweiterung MOD_PCS. Keine allgemein verfügbare Funktion.

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

Projekte GET Projekt abrufen