Get

[POST] .../v1/docsetprice/get

Returns document setting prices. Use this method to list price setting documents before opening a document, checking its lock or posting state or selecting it for SetPriceOperation workflow. The response returns paged DocSetPrice records with next_offset and total, supports filters by id, price_type_id, date, attached_user_id, performed, blocked, deleted_mark and search. The result is constrained by tariff display-period rules over the document date and the current request user must have price setting document select permission. Missing body, denied access, invalid filters or sort_orders, unavailable tariff, database failures or display-period restrictions are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. Server settings define the effective maximum.
offset Int32 Optional Offset from the beginning of the result set. Negative values are treated as 0.
search String Optional Search string for configured document fields.
sort_orders Array of DocSetPriceColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
attached_user_id int Responsible user IDs.
blocked bool Indicates whether the document is locked: true - locked, false - not locked.
date int
deleted_mark bool Indicates whether the document is marked for deletion: true - marked for deletion, false - not marked for deletion.
end_date int Period end date as Unix time in seconds.
id int Price setting document IDs.
performed bool Indicates whether the document is posted: true - posted, false - not posted.
price_type_id int Price type IDs.
start_date int Period start date as Unix time in seconds.

Sortable Fields

Field
blocked
code
date
deleted_mark
id
last_update
performed
price_type.name

Request Example

{
  "filters": [
    {
      "field": "price_type_id",
      "operator": "In",
      "value": "3"
    },
    {
      "field": "performed",
      "operator": "Equal",
      "value": "false"
    },
    {
      "field": "deleted_mark",
      "operator": "Equal",
      "value": "false"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocSetPrice Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 6101,
      "date": 1767225600,
      "code": "SP-000061",
      "price_type": {
        "id": 3,
        "name": "Retail"
      },
      "description": "January retail price update",
      "blocked": true,
      "performed": false,
      "deleted_mark": false,
      "attached_user": {
        "id": 5,
        "name": "John Smith"
      },
      "current_user_blocked": true,
      "last_update": 1767225600
    }
  ],
  "next_offset": 0,
  "total": 1
}