Get

[POST] .../v1/docopeningbalance/get

Returns opening settlement documents with partners. Retrieve opening partner balances using filters for reconciliation or posting. Requires opening balance select permission. Documents include nullable stock_id. Business errors return HTTP 200 ErrorResult. The request supports sort_orders.

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 by parameter values: code - document code, Firm/name - company name, Firm/inn - company TIN, Partner/name - partner name, Partner/inn - partner TIN.
sort_orders	Array of DocOpeningBalanceColumn	Optional	Sort orders. Allowed columns are defined by DocOpeningBalanceColumns.

Filterable Fields

Field	Type	Description
date	int
deleted_mark	bool	Deletion mark state: true - marked for deletion, false - not marked for deletion.
end_date	int	Period end date as Unix time in seconds.
firm_id	int	Company IDs.
id	int	Opening partner balance document IDs.
partner_id	int	Partner IDs.
performed	bool	Document posting state: true - posted, false - not posted.
start_date	int	Period start date as Unix time in seconds.

Sortable Fields

Field
code
credit
currency.name
date
debit
deleted_mark
firm.name
id
last_update
partner.name
performed

Request Example

{
  "filters": [
    {
      "field": "partner_id",
      "operator": "Equal",
      "value": "18"
    },
    {
      "field": "firm_id",
      "operator": "Equal",
      "value": "2"
    },
    {
      "field": "performed",
      "operator": "Equal",
      "value": "false"
    },
    {
      "field": "deleted_mark",
      "operator": "Equal",
      "value": "false"
    },
    {
      "field": "date",
      "operator": "GreaterOrEqual",
      "value": "1711929600"
    },
    {
      "field": "date",
      "operator": "LessOrEqual",
      "value": "1714521599"
    },
    {
      "field": "search",
      "operator": "Like",
      "value": "ACME"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    },
    {
      "column": "code",
      "direction": "ASC"
    }
  ],
  "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 DocOpeningBalance	Result array.
total	Int64	Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 26,
      "date": 1711929600,
      "code": "OBL-000026",
      "partner": {
        "id": 18,
        "name": "ACME Supplies",
        "inn": "301234567"
      },
      "firm": {
        "id": 2,
        "name": "REGOS Retail",
        "inn": "305930137"
      },
      "debit": 1250000.000,
      "credit": 250000.000,
      "exchange_rate": 1.00000000,
      "currency": {
        "id": 1,
        "code_chr": "UZS",
        "name": "Uzbek sum",
        "exchange_rate": 1.00000000,
        "is_base": true
      },
      "performed": false,
      "deleted_mark": false,
      "last_update": 1711931200
    }
  ],
  "next_offset": 0,
  "total": 1
}