Customer Custom Fields

Customer Endpoints using custom fields

All customer API endpoints now support custom fields:

GET /customers - Returns custom fields in response
GET /customers/{code} - Includes custom fields for individual customers
POST /customers - Accepts custom fields when creating customers
PUT /customers/{code} - Updates custom field values

Custom Fields in API Responses

Customer responses now include a customFields array:

GET /customers
{
  "code": "CUST001",
  "name": "John Smith",
  "email": "[email protected]",
  "customFields": [
    {
      "customFieldID": 1,
      "valueString": "Department A"
    },
    {
      "customFieldID": 2,
      "valueString": "VIP Customer"
    },
    {
      "customFieldID": 3,
      "valueString": "20.00"
    }
  ]
}

Creating Customers with Custom Fields

POST /customers
{
  "name": "Jane Doe",
  "email": "[email protected]",
  "customFields": [
    {
      "customFieldID": 1,
      "valueString": "Department B"
    },
    {
      "customFieldID": 2,
      "valueString": "Standard Customer"
    },
    {
      "customFieldID": 3,
      "valueString": "33.00"
    }
  ]
}

Updating Custom Fields

PUT /customers/{Code}
{
  "customFields": [
    {
      "customFieldID": 1,
      "valueString": "Department C"
    },
    {
      "customFieldID": 2,
      "valueString": "High value Customer"
    },
    {
      "customFieldID": 3,
      "valueString": "22.00"
    }
  ]
}

Web Application view

For more information, go to the Customer Field page.