Get

[POST] .../v1/documentenumerator/get

Returns document enumerators. Use this method to retrieve document numbering settings before editing a document mask or resetting the current counter. The response returns document enumerator rows with translated document type name, current mask, current counter value and last update time; filters are id and table_id. The request body is required; id narrows by enumerator ID and table_id narrows by sys_db_tables_ref document table ID. The current request user must have document enumerator select permission and the document enumerator tariff parameter must be enabled. Missing body, denied access, disabled tariff parameter, invalid filters, database errors and translation lookup failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Filterable Fields

Request Example

{
  "filters": [
    {
      "field": "id",
      "operator": "Equal",
      "value": "5"
    },
    {
      "field": "table_id",
      "operator": "Equal",
      "value": "16"
    }
  ]
}

Response Parameters

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 5,
      "table_name": "Purchases",
      "mask": "PUR-{counter}",
      "counter": 12,
      "last_update": 1712345600
    }
  ]
}