Skip to main content
POST
Retained earnings
Use year for an annual retained earnings close. Alternatively, use effective_date to choose a specific date. Preview retained earnings to see the adjustment without creating it.

Cash and accrual reporting

Cash and accrual reports use different retained earnings adjustments.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

Body

application/json

Provide exactly one of year or effective_date.

year
integer
required

Year for the annual retained earnings close.

effective_date
string<date>

Specific date in YYYY-MM-DD format. Use instead of year.

memo
string | null
metadata
object

Arbitrary JSON data defined by the caller, with a 1KB size constraint.

Example:
reference_number
string | null
ledger_activity_start_timestamp
string<date-time>

Optional start of ledger activity to include. Defaults to the business activation timestamp.

retained_earnings_target_account
Account ID · object

Account to receive net income. Defaults to the retained earnings account.

override_default_tagging_strategy
object[]

Tag set to close instead of the business default. Omitting this field uses the default strategy, which may create separate closing actions per entity.

Response

201 - application/json

Retained earnings closing actions created.

data
object
required