Angebote auflisten

Liefert eine paginierte Liste der Angebote.

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

Request

GET /api/v1/offers

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/offers' \
     --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
id[]
Type
Liste von string, nullable
Description
Beschränkt das Ergebnis auf eine oder mehrere Angebots-IDs.

Response

{
  "data": [
    {
      "id": 1,
      "name": "EU",
      "customer_id": 1,
      "customer_contact_id": 789,
      "department_id": 1,
      "project_id": 16,
      "ticket_id": 1234,
      "title": "Dr.",
      "note": "Familienurlaub",
      "version": "2.0",
      "status": {
        "id": 1,
        "name": "neu"
      },
      "status_since": "2024-08-27T14:27:01.000000Z",
      "responsible_username": "string",
      "processor_username": "frank",
      "is_net": 0,
      "currency": "EUR",
      "default_validity": 30,
      "valid_until": "2024-11-30T00:00:00.000000Z",
      "order_date": "2026-01-31T09:00:00.000000Z",
      "address": "Musterstraße 123",
      "keywords": {},
      "language": "de",
      "realization_from": "2025-01-01T00:00:00.000000Z",
      "realization_until": "2025-03-31T00:00:00.000000Z",
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ],
      "items_count": 1,
      "order_probability_percent": 50
    }
  ],
  "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 Angebots.
Name
name
Type
string, nullable
Description
Die Angebotsnummer, die als lesbare Kennung des Angebots dient.
Name
customer_id
Type
integer, nullable
Description
Die ID des Kunden, für den dieses Angebot erstellt wurde.
Name
customer_contact_id
Type
integer, nullable
Description
Die ID des Ansprechpartners, an den sich dieses Angebot richtet, falls vorhanden.
Name
department_id
Type
integer, nullable
Description
Die ID der Abteilung, die dieses Angebot erstellt hat.
Name
project_id
Type
integer, nullable
Description
Die ID des Projekts, mit dem dieses Angebot verknüpft ist, falls vorhanden.
Name
ticket_id
Type
integer, nullable
Description
Die ID des Tickets, aus dem dieses Angebot hervorgegangen ist, falls vorhanden.
Name
title
Type
string
Description
Der Titel des Angebots, wie er dem Kunden angezeigt wird.
Name
note
Type
string, nullable
Description
Interne Notizen zum Angebot, die dem Kunden nicht angezeigt werden.
Name
version
Type
string, nullable
Description
Die Versionsnummer des Angebots, die bei jeder Überarbeitung erhöht wird.
Name
status
Type
object
Description
Der Status des Angebots in seinem Lebenszyklus (z. B. neu, beauftragt, abgelehnt).
Name
status.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
status.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "neu", "in Arbeit", "Finished", "in Prüfung", "Reviewed", "Dokument erstellt", "Offered as mail", "Offered as letter", "Ordered", "bestätigt", "Transferred to project", "Settled", "Declined"
Name
status_since
Type
string (date-time), nullable
Description
Datum und Uhrzeit der letzten Statusänderung des Angebots.
Name
responsible_username
Type
string, nullable
Description
Der Benutzername des für dieses Angebot verantwortlichen Mitarbeiters.
Name
processor_username
Type
string, nullable
Description
Der Benutzername des Mitarbeiters, der dieses Angebot aktuell bearbeitet.
Name
is_net
Type
integer, nullable
Description
Ob die Preise des Angebots netto (ohne Umsatzsteuer) statt brutto angegeben sind.
Name
currency
Type
string, nullable
Description
Der ISO-Währungscode, der für die Preise dieses Angebots verwendet wird.
Name
default_validity
Type
integer, nullable
Description
Die Anzahl der Tage, die dieses Angebot standardmäßig gültig ist, gerechnet ab seiner Erstellung.
Name
valid_until
Type
string (date-time), nullable
Description
Das Datum, bis zu dem dieses Angebot gültig ist.
Name
order_date
Type
string (date-time), nullable
Description
Das Datum, an dem der Kunde auf Basis dieses Angebots bestellt hat, sofern es beauftragt wurde.
Name
address
Type
string, nullable
Description
Die auf dem Angebotsdokument gedruckte Adresse.
Name
keywords
Type
object, nullable
Description
Kommagetrennte Freitext-Schlagwörter zum Suchen und Filtern von Angeboten.
Name
language
Type
string, nullable
Description
Die Sprache, in der das Dokument dieses Angebots verfasst ist.
Name
realization_from
Type
string (date-time), nullable
Description
Das Startdatum des Zeitraums, in dem die angebotene Leistung erbracht werden soll.
Name
realization_until
Type
string (date-time), nullable
Description
Das Enddatum des Zeitraums, in dem die angebotene Leistung erbracht werden soll.
Name
categories
Type
Liste von Category
Description
Die diesem Angebot zugeordneten Kategorien. Nur bei GET /offers/{offer} vorhanden; nicht beim Listen-Endpunkt GET /offers.
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
items_count
Type
integer
Description
Die Anzahl der Positionen dieses Angebots. Nur bei GET /offers/{offer} vorhanden; nicht beim Listen-Endpunkt GET /offers.
Name
order_probability_percent
Type
integer, nullable
Description
Die geschätzte Wahrscheinlichkeit in Prozent, dass dieses Angebot beauftragt wird.

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

Angebote GET Angebot abrufen