Customers

The Customers entity represents individual users or clients within the system, including their authentication, financial state, and access permissions.

Fields

Field	Type	Description
id	Integer	Unique identifier (Primary Key).
name	String	Full name of the customer.
email	String	Email address.
cardId	String	Physical card identifier (e.g., RFID).
company	Relation	The company this customer belongs to.
externalId	String	External system reference ID.
isBlocked	Boolean	Whether the customer account is locked.
isCreditAllowed	Boolean	Flag indicating if the customer can have a negative balance.
totalDebt	Float	Current total debt amount.
debtData	JSON	Detailed technical debt information.
paymentCard	String	Linked payment card identifier (masked).
default	Boolean	Flag for default system customers.
createdAt	DateTime	Metadata: Creation timestamp.
updatedAt	DateTime	Metadata: Last update timestamp.

---

Get List of Customers

Endpoint: POST /core/data/Customers/select

Example Request:

{
  "fields": {
    "id": true,
    "name": true,
    "email": true,
    "isBlocked": true,
    "company": { "id": true }
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "isBlocked",
        "comparator": "=",
        "value": false
      }
    ]
  },
  "orderBy": [
    {
      "field": "name",
      "order": "asc"
    }
  ],
  "limit": 100,
  "offset": 0
}

---

Get Single Customer

Endpoint: POST /core/data/Customers/select

Example Request:

{
  "fields": {
    "id": true,
    "name": true,
    "cardId": true,
    "totalDebt": true,
    "isCreditAllowed": true
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 123
      }
    ]
  },
  "limit": 1
}

---

Create Customer

Endpoint: POST /core/data/Customers/insert

Example Request:

{
  "fields": [
    {
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "cardId": "A1B2C3D4",
      "company": { "id": 42 },
      "isCreditAllowed": true
    }
  ]
}

---

Update Customer

Endpoint: POST /core/data/Customers/update/{id}

Example Request:

{
  "fields": {
    "isBlocked": true,
    "name": "Jane Smith"
  }
}

---

Delete Customers

Endpoint: POST /core/data/Customers/remove

Example Request:

{
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "id",
        "comparator": "in",
        "value": [123, 124]
      }
    ]
  }
}