Add

[POST] .../v1/docopeningbalance/add

Creates a new opening settlement document with partner. Create an unposted opening partner balance and return new_id. Requires opening balance add permission; use Perform to post it. Base currency uses exchange_rate 1. Optional stock_id must belong to the company; omitted, null or zero leaves it unassigned. Business errors return HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
credit Decimal Optional Credit amount value with up to 3 decimal places. If omitted, the value is stored as 0.
currency_id Int64 Required Required currency ID.
date Int64 Required Required document date as Unix time in seconds.
debit Decimal Optional Debit amount value with up to 3 decimal places. If omitted, the value is stored as 0.
exchange_rate Decimal Required Required exchange rate relative to the base currency. For the base currency the server stores 1; for non-base currency it must fit decimal(18,8).
firm_id Int64 Required Required company ID.
partner_id Int64 Required Required partner ID.
stock_id Int64 Optional Optional stock ID belonging to firm_id. Omitted, null or 0 means no stock. The document basis is not used to select a stock.

Request Example

{
  "date": 1711929600,
  "partner_id": 18,
  "firm_id": 2,
  "debit": 1250000.000,
  "credit": 250000.000,
  "exchange_rate": 1.00000000,
  "currency_id": 1
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 26
  }
}