Skip to content

CustomerClients ​

Customer clients represent end customers of the business - typically companies or individuals who receive invoices. Used for B2B invoicing and customer relationship management.

Storage Location ​

{customer_id}-customer_client.json

Fields ​

FieldTypeRequiredDescription
idguidYesUnique customer client identifier.
customer_idintegerYesReference to Customer (tenant).
namestringYesCustomer client name (company or individual).
typestringYesClient type: invoice, loyalty, etc.
groupsarrayNov1.3. Groups the client belongs to: array of {"id": <number>, "name": <string>}. Active groups only, ordered by name. Absent when the client has no active groups.

Example ​

json
{
  "id": "f9aebcee-e4fe-6a01-e053-0a01000a8e33",
  "customer_id": 10352,
  "name": "TREATS AS",
  "type": "invoice",
  "groups": [{"id": 7, "name": "VIP"}]
}

Example - Multiple Customer Clients ​

json
[
  {
    "id": "f9aebcee-e4fe-6a01-e053-0a01000a8e33",
    "customer_id": 10352,
    "name": "TREATS AS",
    "type": "invoice"
  },
  {
    "id": "f9aec709-a148-6ffe-e053-0a01000a2803",
    "customer_id": 10352,
    "name": "TRIPLETEX AS",
    "type": "invoice"
  },
  {
    "id": "fbcb6366-f777-b099-e053-0a01000aaece",
    "customer_id": 10352,
    "name": "EWORK GROUP NORWAY AS",
    "type": "invoice"
  },
  {
    "id": "0873a1b2-d710-7d4d-e065-022248dcba1a",
    "customer_id": 10352,
    "name": "NORGES BANK",
    "type": "invoice"
  }
]

Client Types ​

TypeDescription
invoiceInvoice customer - receives invoices for orders
loyaltyLoyalty program member

Technical documentation for partners and integrators