Artikel aus dem Artikelkatalog auflisten, optional gefiltert und paginiert

Enthält auch inaktive Artikel, sofern der Filter sie nicht ausschließt.

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

Request

GET /api/v1/articles

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/articles' \
     --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.

Response

{
  "data": [
    {
      "id": 1,
      "article_number": "ART-001",
      "name": "EU",
      "unit": "Stunde",
      "unit_price": 1.5,
      "currency": "EUR",
      "description": "Angebot|en:offer",
      "inactive": false,
      "description_en": "Professional consulting services",
      "description_fr": "Développement de logiciels",
      "description_es": "string",
      "description_pl": "string",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "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 Artikels.
Name
article_number
Type
string, nullable
Description
Die Artikelnummer, über die dieser Artikel extern referenziert wird.
Name
name
Type
string, nullable
Description
Name des Artikels, wie er auf Rechnungen und Preislisten angezeigt wird.
Name
unit
Type
string, nullable
Description
Die Einheit, in der dieser Artikel bepreist und abgerechnet wird, z. B. Stück oder Stunde.
Name
unit_price
Type
number, nullable
Description
Preis des Artikels pro Einheit in der angegebenen Währung.
Name
currency
Type
string, nullable
Description
Der dreistellige Währungscode, in dem unit_price angegeben ist.
Name
description
Type
string, nullable
Description
Standard-Beschreibungstext des Artikels in der Hauptsprache des Mandanten.
Name
inactive
Type
boolean
Description
Ob der Artikel deaktiviert wurde und in neuen Auswahlen ausgeblendet ist.
Name
description_en
Type
string, nullable
Description
Beschreibungstext des Artikels auf Englisch, für mehrsprachige Rechnungen.
Name
description_fr
Type
string, nullable
Description
Beschreibungstext des Artikels auf Französisch, für mehrsprachige Rechnungen.
Name
description_es
Type
string, nullable
Description
Beschreibungstext des Artikels auf Spanisch, für mehrsprachige Rechnungen.
Name
description_pl
Type
string, nullable
Description
Beschreibungstext des Artikels auf Polnisch, für mehrsprachige Rechnungen.
Name
created
Type
string (date-time), nullable
Description
Zeitpunkt, zu dem der Artikeldatensatz erstellt wurde.
Name
modified
Type
string (date-time), nullable
Description
Zeitpunkt, zu dem der Artikeldatensatz zuletzt geändert wurde.

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

Artikel GET Einzelnen Artikel anhand seiner ID abrufen