Schema & Enums

Endpoints for retrieving the structure of entities and technical metadata.

Enumeration Values (Enums)

Retrieve available enums and their values.

List All Available Enums

To get a list of all enumeration types available in the system, use the groupBy parameter on the name field.

Endpoint: POST /core/data/Enums/select

Request Body

{
  "fields": {
    "name": true
  },
  "groupBy": [
    { "field": "name" }
  ]
}

Response Body (Example)

[
  { "name": "CustomerGroupLimits.period" },
  { "name": "FiscalTransactions.type" },
  { "name": "ReceiptPayments.type" },
  { "name": "Products.type" }
]

Retrieve Specific Enum Values

Retrieve the labels, values, and internal IDs for a specific enum by filtering by its name.

Endpoint: POST /core/data/Enums/select

Request Body (Example for ReceiptPayments.type)

{
  "fields": {
    "id": true,
    "name": true,
    "value": true
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "name",
        "comparator": "=",
        "value": "ReceiptPayments.type"
      }
    ]
  }
}

Response Body

[
  {
    "id": 71,
    "name": "ReceiptPayments.type",
    "value": "prepayment"
  },
  {
    "id": 72,
    "name": "ReceiptPayments.type",
    "value": "payment"
  },
  {
    "id": 73,
    "name": "ReceiptPayments.type",
    "value": "reversal"
  }
]