Commit contact opening balance

Commit contact opening balance in the credential-bound company. Call contactOpeningBalance.preview first and include its confirmation token when committing this action. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. If-Match is required with the latest ETag; stale versions return 412. This action posts accounting effects. Requires the opening-balances:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Confirmed values used to commit contact opening balance, including the confirmation token returned by contactOpeningBalance.preview.

date
required
string
required
customer_balances
array of objects
required
customer_balances*
vendor_balances
array of objects
required
vendor_balances*
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*