Domain Message

A Domain is any organizational unit that needs to maintain a separate set of account balances while using the same Chart of Accounts as other Domains. There is always at least one Domain. The name of the default domain is "MAIN". The default can be overridden when the ledger is created.

Business Rules

  • Domain codes must be unique.
  • Domain codes are mapped to uppercase.
  • The Domain must have at least one name.
  • The currency must be defined.

Domain Message Properties

Property Type Description
code string A unique identifier for the Domain.
currencyDefault string The Currency code that is used in journal entries by default.
extra string An arbitrary string for use by the application.
names Name A list of names for the domain.
revision string The revision hash code for the Domain.
subJournals bool Set true when the Domain has separate journals. Default: false.
toCode string A new Domain code to be assigned in an update operation.

Requirements for each Command

Property Add Delete Get Update
code M M M M
currencyDefault M _ _ O
extra O _ _ O
names M _ _ O
revision _ _ _ M
subJournals O _ _ O
toCode _ _ _ O
  • O - Optional
  • M - Must be supplied
  • X - Invalid
  • _ - Ignored