Positionen eines Angebots auflisten

Liefert eine paginierte Liste der Positionen des angegebenen Angebots.

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

Request

GET /api/v1/offers/{id}/items

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/offers/{id}/items' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Pfad-Parameter

Name
id
Type
integer
Description
Die ID des Angebots

Query-Parameter

Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.

Response

{
  "data": [
    {
      "id": 1,
      "offer_id": 1,
      "position": "1",
      "label": "&laquo; Previous",
      "description": "Angebot|en:offer",
      "type": {
        "id": "string",
        "name": "Gliederung"
      },
      "quantity": 1.5,
      "unit": "Stunde",
      "single_price": 1.5,
      "receipts_mileage_money": 1.5,
      "additional_meal_expenses": 1.5,
      "amount_deviating_net": 1.5,
      "display_calculation": false,
      "display_total": true,
      "is_alternative": false,
      "sort_order": 1,
      "article_id": 1,
      "expenditure_billing_type": {
        "id": "string",
        "name": "Stundensatz"
      },
      "vat": 1.5
    }
  ],
  "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 Angebotsposition.
Name
offer_id
Type
integer
Description
Die ID des Angebots, zu dem diese Position gehört.
Name
position
Type
string, nullable
Description
Die Positionsnummer dieser Position im Angebot, z. B. “1” oder “2.1” für eine Unterposition.
Name
label
Type
string, nullable
Description
Der Kurztitel der Position, wie er auf dem Angebot gedruckt wird.
Name
description
Type
string, nullable
Description
Eine längere Freitextbeschreibung der Position, gedruckt unter ihrem Titel.
Name
type
Type
object
Description
Der Typ der Position (z. B. Artikel, Aufwand oder prozentualer Zuschlag), der bestimmt, welche der übrigen Felder gelten.
Name
type.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Gliederung", "Artikel", "Expenditure", "Pauschal", "Fixed price (free)", "Surcharge in percent"
Name
quantity
Type
number
Description
Die Menge dieser Position.
Name
unit
Type
string, nullable
Description
Die Einheit, in der die Menge angegeben ist (z. B. Stunden, Stück oder Prozent), abgeleitet aus dem Typ der Position.
Name
single_price
Type
number
Description
Der Preis pro Einheit dieser Position, in der Währung des Angebots.
Name
receipts_mileage_money
Type
number, nullable
Description
Das erstattete Kilometergeld, das in der Summe dieser Aufwandsposition enthalten ist, sofern vorhanden.
Name
additional_meal_expenses
Type
number, nullable
Description
Der erstattete Verpflegungsmehraufwand, der in der Summe dieser Aufwandsposition enthalten ist, sofern vorhanden.
Name
amount_deviating_net
Type
number, nullable
Description
Ein Nettobetrag, der die berechnete Summe dieser Position überschreibt, sofern gesetzt.
Name
display_calculation
Type
boolean
Description
Ob die Kalkulationsaufstellung dieser Position auf dem Angebotsdokument angezeigt wird.
Name
display_total
Type
boolean
Description
Ob der Gesamtpreis dieser Position auf dem Angebotsdokument angezeigt wird.
Name
is_alternative
Type
boolean
Description
Ob diese Position eine Alternativposition ist, die angeboten, aber nicht in die Angebotssumme einbezogen wird.
Name
sort_order
Type
integer, nullable
Description
Die Sortierposition dieser Position unter den Positionen des Angebots.
Name
article_id
Type
integer, nullable
Description
Die ID des Artikels, auf dem diese Position basiert, sofern vorhanden.
Name
expenditure_billing_type
Type
object, nullable
Description
Wie eine Aufwandsposition abgerechnet wird (z. B. Tagessatz oder Stundensatz).
Name
expenditure_billing_type.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
expenditure_billing_type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Stundensatz", "Tagessatz"
Name
vat
Type
number, nullable
Description
Der auf diese Position angewendete Mehrwertsteuersatz in Prozent.

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

GET Angebot abrufen GET Angebotsposition abrufen