Get

[POST] .../v1/docperiodclosing/get

Returns information about document closing period. Use this method to retrieve period closing documents for monitoring, audit screens and follow-up workflow decisions. The request body is required, the caller needs the period closing select permission and the query supports filters by id, status_id, firm_id, close_date, run_date and search. The response returns a paged list with close_date, run_date, translated status text, status_id, firm, description, scheduler_uuid, next_offset and total. Business errors such as missing body, denied access, invalid filters or sort_orders, database failures or translation lookup failures are returned as HTTP 200 ErrorResult.

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. The default and maximum values are defined by the server-side query_limit setting.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for fields: id - document ID, Firm/name - company name, Firm/inn - company TIN.
sort_orders Array of DocPeriodClosingColumn Optional Sort orders. Allowed columns are defined by DocPeriodClosingColumns.

Filterable Fields

Field Type Description
close_date int
close_date_end int Period closing date range end as Unix time in seconds.
close_date_start int Period closing date range start as Unix time in seconds.
firm_id int Company IDs.
id int Period closing document IDs.
run_date int
run_date_end int Period closing processing date range end as Unix time in seconds.
run_date_start int Period closing processing date range start as Unix time in seconds.
status_id int Period closing document status IDs.

Sortable Fields

Field
close_date
firm.name
id
run_date
status.name

Request Example

{
  "filters": [
    {
      "field": "firm_id",
      "operator": "In",
      "value": "2"
    },
    {
      "field": "status_id",
      "operator": "In",
      "value": "1,2"
    },
    {
      "field": "close_date",
      "operator": "LessOrEqual",
      "value": "1714521599"
    },
    {
      "field": "search",
      "operator": "Like",
      "value": "REGOS"
    }
  ],
  "sort_orders": [
    {
      "column": "close_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 DocPeriodClosing Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 44,
      "close_date": 1714521599,
      "run_date": 1714535999,
      "status": "WAITING_CLOSE",
      "status_id": 1,
      "firm": {
        "id": 2,
        "name": "REGOS Retail",
        "inn": "305930137"
      },
      "description": "April 2024 closing",
      "scheduler_uuid": "7f3a25f8-5950-40f2-9f80-f3e6b7c73d54",
      "last_update": 1714525200
    }
  ],
  "next_offset": 0,
  "total": 1
}