Perform

[POST] .../v1/docopeningbalance/perform

Posts opening settlement document with partner. Use this method to post an opening partner balance document so its values participate in partner balance accounting. The request body is required, id is required, the caller needs the opening balance perform permission and the document must be locked for the posting operation. The document must be unposted, not marked for deletion and not deleted; if the state does not allow posting, the persistent layer returns a business error. The response returns row_affected and fires the DocOpeningBalancePerformed webhook; business errors such as missing body, invalid id, denied access, no matching row, invalid document state or database failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Required opening partner balance document ID.

Request Example

{
  "id": 26
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}