Get an offer item

Returns a single item of the given offer.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

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

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

Path parameters

Name
id
Type
integer
Description
The offer ID
Name
item_id
Type
integer
Description
The item ID

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

Response fields

Name
id
Type
integer
Description
The offer item’s unique identifier.
Name
offer_id
Type
integer
Description
The id of the offer this item belongs to.
Name
position
Type
string, nullable
Description
The position number of this item on the offer, e.g. “1” or “2.1” for a sub-item.
Name
label
Type
string, nullable
Description
The item’s short title, as printed on the offer.
Name
description
Type
string, nullable
Description
A longer free-text description of the item, printed below its label.
Name
type
Type
object
Description
The item’s type (e.g. article, expenditure, or a percentage surcharge), which determines which of the other fields apply.
Name
type.id
Type
string
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Gliederung", "Artikel", "Expenditure", "Pauschal", "Fixed price (free)", "Surcharge in percent"
Name
quantity
Type
number
Description
The quantity of this item.
Name
unit
Type
string, nullable
Description
The unit the quantity is measured in (e.g. hours, pieces, or percent), derived from the item’s type.
Name
single_price
Type
number
Description
The price per unit of this item, in the offer’s currency.
Name
receipts_mileage_money
Type
number, nullable
Description
The reimbursed mileage allowance included in this expenditure item’s total, if any.
Name
additional_meal_expenses
Type
number, nullable
Description
The reimbursed meal-allowance amount included in this expenditure item’s total, if any.
Name
amount_deviating_net
Type
number, nullable
Description
A net amount that overrides the calculated total for this item, if set.
Name
display_calculation
Type
boolean
Description
Whether the calculation breakdown for this item is shown on the offer document.
Name
display_total
Type
boolean
Description
Whether this item’s total price is shown on the offer document.
Name
is_alternative
Type
boolean
Description
Whether this item is an alternative position, offered but not included in the offer’s total.
Name
sort_order
Type
integer, nullable
Description
The item’s sort position among the offer’s items.
Name
article_id
Type
integer, nullable
Description
The id of the article this item is based on, if any.
Name
expenditure_billing_type
Type
object, nullable
Description
How an expenditure item is billed (e.g. daily rate or hourly rate).
Name
expenditure_billing_type.id
Type
string
Description
The stored value. Compare against this, not against name.
Name
expenditure_billing_type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Stundensatz", "Tagessatz"
Name
vat
Type
number, nullable
Description
The VAT rate applied to this item, as a percentage.

Generated from the OpenAPI specification — edit the source code, not this page.

GET List an offer's items Invoices