---
title: "Query Sales Order Custom Fields"
method: GET
path: "/v2/salesOrders/customfields"
tags: ["salesorder"]
---

# Query Sales Order Custom Fields

`GET /v2/salesOrders/customfields`

Query all custom fields for a sales order

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Response `200`

The requested custom fields for sales orders.

- JTLWawiRestContractsModelsV1CommonCustomField[]
  - `attribut` JTLEntitiesDboTableAttributEntity — Attribute dienen zur flexibleren Verteilung von Eigenschaften zu bestimmten Objekten
    - `id` integer — Primärschlüssel der Tabelle
    - `istMehrsprachig` integer — Gibt an ob dieses Attribut ein mehrsprachiges Attribut ist
    - `istFreifeld` integer — Gibt an ob es sich bei dem Attribut um ein Benutzerdefiniertes Attribut handelt
    - `sortierung` integer — Gibt die Sortierreihenfolge dieses Attributs an
    - `beschreibung` string — Enthält einen Beschreibungstext zum Attribut
    - `bezugstyp` integer — Der Bezugstyp gibt an zu welchen anderen Objekten dieses Attribut einen Bezug hat
    - `ausgabeweg` integer — Bestimmt wo dieses Attribut für Benutzer dargestellt werden soll. Wenn > 0, dann ist es z.B. ein Freifeld.
    - `istStandard` integer — Gibt an, ob das Attribut von uns vorgegeben ist und nicht gelöscht werden darf
    - `feldTypId` integer — Verweis auf den Primärschlüssel der Tabelle dbo.tFeldTyp.
    - `regEx` string — Gibt einen regulären Ausdruck an der verwendet wird um die Wertmenge einzuschränken oder zu formatieren
    - `gruppeName` string — Name der Gruppe zu dem das Attribut gehört.
    - `readOnly` integer — Gibt an, ob das Attribut Read Only ist.
    - `aktivFuerArtikelOhneWarengruppe` boolean
    - `istPflichtfeld` boolean
    - `attributId` string
    - `istUnsichtbar` boolean — Bestimmt ob das Attribut/Eigenes Feld in der UI unsichtbar bleiben soll.
    - `skipHooks` boolean
    - `feldTyp` JTLEntitiesDboTableFeldTypEntity — Typ eines definierten semantischen Feldes welches mit einem primitiven Datentyp verknüpft ist
      - `id` integer — Primärschlüssel der Tabelle
      - `name` string — Name des semantischen Feldes
      - `datenTyp` integer — Gibt den primitiven Datentypen an der verwendet wird um dieses Feld zu speichern
      - `regEx` string — Gibt einen regulären Ausdruck an der verwendet wird um die Wertmenge einzuschränken oder zu formatieren
      - `skipHooks` boolean
      - `typ` 0 | 1 | 2 | 3 — 0 = Integer, 1 = Decimal, 2 = String, 3 = DateTime
    - `bezeichnungen` JTLEntitiesDboTableAttributSpracheEntity[]
      - `attributId` integer — Enthält den Referenzschlüssel auf das Attribut.
      - `spracheId` integer — Enthält den Referenzschlüssel auf die Sprache.
      - `name` string — Name des Attributs in der jeweiligen Sprache
      - `wertListe` string — Wertliste mit separierten stringvalues die als Optionen bereitgestellt werden
      - `skipHooks` boolean
  - `customFieldId` string, uuid
  - `groupName` string — The group name for this custom field.
  - `name` string — The custom field name.
  - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — 0 = None, 1 = Integer, 2 = Decimal, 3 = Text, 4 = Checkbox, 5 = List, 6 = Url, 7 = Email, 8 = PhoneNumber, 9 = CountryIso, 10 = Price, 11 = Date, 12 = ShortText
  - `possibleValues` string[] — The possible values, when the custom field is a list.

## Other responses

- `401`
- `402` — No licence available or the app has not been authorised by JTL.
- `404` — No fields could be found.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/versions/f979b1ea6951/schema)