latestOpenAPI 3.0.22026-08-1010030.9 KB

e4ceb0dc32d4

ledgers

Open a ledger

Opens the entity's ledger for the given accounting basis and returns it. Kick backfills the ledger from the entity's existing bookkeeping, so postings made before the accrual ledger existed are reflected in it. The call is idempotent: an entity keeps one ledger per basis, and repeating it returns the existing ledger with 200 instead of creating another. Entities Kick does not keep books for (personal entities, and businesses with no legal type) are rejected with 400.

post/platform/v1/entities/{entityId}/ledgers

Path parameters

entityIdstring uuid required

Request body

basis'cash' | 'accruals' required

Accounting basis of the ledger to open. accruals opens the entity's accrual ledger; cash resolves to the cash ledger every entity already keeps.

Response

200