List offers

Returns a paginated list of offers.

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

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 parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
id[]
Type
array of string, nullable
Description
Restrict the result to one or more offer 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 fields

Name
id
Type
integer
Description
The offer’s unique identifier.
Name
name
Type
string, nullable
Description
The offer’s number, used as its human-readable identifier.
Name
customer_id
Type
integer, nullable
Description
The id of the customer this offer was written for.
Name
customer_contact_id
Type
integer, nullable
Description
The id of the customer contact this offer addresses, if any.
Name
department_id
Type
integer, nullable
Description
The id of the department that created this offer.
Name
project_id
Type
integer, nullable
Description
The id of the project this offer is linked to, if any.
Name
ticket_id
Type
integer, nullable
Description
The id of the ticket this offer originated from, if any.
Name
title
Type
string
Description
The offer’s title, as shown to the customer.
Name
note
Type
string, nullable
Description
Internal notes about the offer, not shown to the customer.
Name
version
Type
string, nullable
Description
The offer’s version number, incremented each time it is revised.
Name
status
Type
object
Description
The offer’s status in its lifecycle (e.g. new, ordered, declined).
Name
status.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
status.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "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
The date and time the offer last changed status.
Name
responsible_username
Type
string, nullable
Description
The username of the employee responsible for this offer.
Name
processor_username
Type
string, nullable
Description
The username of the employee currently processing this offer.
Name
is_net
Type
integer, nullable
Description
Whether the offer’s prices are net (excluding VAT) rather than gross.
Name
currency
Type
string, nullable
Description
The ISO currency code used for this offer’s prices.
Name
default_validity
Type
integer, nullable
Description
The number of days this offer is valid for by default, counted from its creation.
Name
valid_until
Type
string (date-time), nullable
Description
The date until which this offer is valid.
Name
order_date
Type
string (date-time), nullable
Description
The date the customer placed the order based on this offer, if it was ordered.
Name
address
Type
string, nullable
Description
The address printed on the offer document.
Name
keywords
Type
object, nullable
Description
Free-text, comma-separated keywords for searching and filtering offers.
Name
language
Type
string, nullable
Description
The language this offer’s document is written in.
Name
realization_from
Type
string (date-time), nullable
Description
The start date of the period in which the offered work is planned to be carried out.
Name
realization_until
Type
string (date-time), nullable
Description
The end date of the period in which the offered work is planned to be carried out.
Name
categories
Type
array of Category
Description
The categories assigned to this offer. Present only on GET /offers/{offer}; absent on the list endpoint GET /offers.
Name
categories.name
Type
string
Description
Name of the category, shown wherever an entity is tagged with it.
Name
categories.description
Type
object
Description
Longer explanation of what this category should be used for.
Name
categories.type
Type
object
Description
The kind of entity this category can be attached to, e.g. employee, project or customer.
Name
items_count
Type
integer
Description
The number of items on this offer. Present only on GET /offers/{offer}; absent on the list endpoint GET /offers.
Name
order_probability_percent
Type
integer, nullable
Description
The estimated probability, in percent, that this offer will be ordered.

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

Offers GET Get an offer