v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

customer

Query Customer Custom Fields

Query all custom fields available for a customer

get/v2/customers/customfields

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The requested custom fields for items.

customFieldIdstring uuid

groupNamestring

The group name for this custom field.

namestring

The custom field name.

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

possibleValuesstring[]

The possible values, when the custom field is a list.

Example response

[
  {
    "customFieldId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]