Artikel
2 Endpunkte unter /api/rest/2.0
Article catalogue
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
Diese Ressource ist nur lesend. Sie liefert die Daten für Auswahl und Anzeige; angelegt und geändert wird in der Oberfläche.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/articles |
Search articles |
GET |
/articles/{id} |
Get a article |
Felder
Diese Felder liefert die API zu Artikel. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
nr |
string | Article number (configurable: system setting "articleNumber" controls whether the number is entered manually or drawn from a sequence) |
article |
string | Article description |
article_type |
string | Article kind |
node_id |
integer | Article group node ID |
external_id |
string | External ID for integration |
ean |
integer | EAN/GTIN (configurable: only in use when the system setting "articleean" is enabled; otherwise the field stays empty and is ignored on write) |
intern |
string | Internal note (configurable: only in use when the system setting "articleintern" is enabled; otherwise the field stays empty and is ignored on write) |
url |
string | Article URL (configurable: only in use when the system setting "articleurl" is enabled; otherwise the field stays empty and is ignored on write) |
weight |
number | Weight (configurable: only in use when the system setting "articleweight" is enabled; otherwise the field stays empty and is ignored on write) |
sk |
integer | Cost centre (configurable: only in use when the system setting "articleSk" is enabled; otherwise the field stays empty and is ignored on write) |
sequential |
boolean | Serial number tracking (configurable: only in use when the system setting "articleSequential" is enabled; otherwise the field stays empty and is ignored on write) |
intrastat_cn |
string | Intrastat commodity code (configurable: only in use when the system setting "articleIntrastatCn" is enabled; otherwise the field stays empty and is ignored on write) |
intrastat_exclude |
boolean | Excluded from Intrastat reporting (configurable: only in use when the system setting "articleIntrastatCn" is enabled; otherwise the field stays empty and is ignored on write) |
country_of_origin |
string | Country of origin (ISO 3166-1 alpha-2) (configurable: only in use when the system setting "articleCountryOfOrigin" is enabled; otherwise the field stays empty and is ignored on write) |
price |
number | Unit price |
minimum_price |
number | Minimum price (configurable: only in use when the system setting "articleMinimumPrice" is enabled; otherwise the field stays empty and is ignored on write) |
cost |
number | Purchase price |
average_cost |
number | Moving average purchase price |
price_calculator |
string | Price calculation rule |
mwst |
string | Whether the price is gross or net |
tax_id |
integer | Tax key ID |
pricelist |
boolean | Appears in the price list |
last_price_change |
date-time | Timestamp of the last price change |
nodiscount |
boolean | Excluded from discounts (configurable: only in use when the system setting "articlediscountsetting" is enabled; otherwise the field stays empty and is ignored on write) |
max_discount_percent |
number | Maximum discount in percent (configurable: only in use when the system setting "articlediscountsetting" is enabled; otherwise the field stays empty and is ignored on write) |
unit |
string | Unit of measure |
factor_qty |
number | Quantity factor (configurable: only in use when the system setting "articleQtyFactor" is enabled; otherwise the field stays empty and is ignored on write) |
qty_formula_id |
integer | Quantity formula ID |
price_formula_id |
integer | Price formula ID |
active |
boolean | Whether the article is active |
buyable |
boolean | Can be purchased |
stockable |
boolean | Stock is tracked |
cultivable |
boolean | Can be produced |
shop |
boolean | Published in the shop |
expense |
boolean | Booked as an expense |
acrual |
boolean | Subject to accrual accounting |
timeclearance |
boolean | Used for time entry settlement |
reverse_charge_constructionservices |
boolean | Reverse charge for construction services (§13b UStG) |
bundle_use_discount_article |
boolean | Bundle discount is carried by a discount article (configurable: only in use when the system setting "articlebundle" is enabled; otherwise the field stays empty and is ignored on write) |
reference_mode |
string | Whether a reference is required on receipt positions |
commission_percent |
number | Commission in percent |
commission_fixed |
number | Fixed commission amount |
commission_dynamic |
boolean | Commission is calculated dynamically |
sort |
integer | Sort order |
image_file_id |
integer | Image file ID |
created_at |
date-time | Creation timestamp |
created_by |
integer | Creator user ID |
updated_at |
date-time | Last update timestamp |
updated_by |
integer | Last updater user ID |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.