Banking

Set a register's opening balance from its statement

Posts one entry against Opening Balance Equity so the register's book balance on asOfDate equals the statement balance. statementBalanceCents is entered as the statement shows it (a card or loan's amount owed is positive). Only the difference from the current book balance is posted; preview=true posts nothing. Honors Idempotency-Key.

post/bank-accounts/{bankAccountId}/opening-balance

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-accounts/{bankAccountId}/opening-balance
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

bankAccountIdstring uuid required

LedgerHQ bank account UUID

Request body

asOfDatestring date required
statementBalanceCentsinteger required
previewboolean

Response

Book balance before, target, adjustment, and the posted entry when one was needed

Changes

No recorded changes to this operation across all 5 revisions of this API.