AccountingRules

post/v1/portfolios/{portfolioSlug}/accounting-rules

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/accounting-rules
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Request body

namestring required

Human-readable rule name, shown in the rules list.

enabledboolean

Whether the rule evaluates. A disabled rule is kept but never fires.

Response

mode'sync' | 'async' required

Whether the command ran sync or async

jobIdstring

Tracking job id, present for asynchronous commands

status'queued'

Queue status, present for asynchronous commands

Changes

No recorded changes to this operation across all 1 revision of this API.