Balance - Well Starter Kit

Balance Entity
Attributes
Relationships

Balance Entity

The Balance entity tracks account balance information including local and accounting currency balances, foreign exchange rates, and balance period definitions.

Attributes

Name	Type	Required	Constraints	Allowed Values	Description	Example
`id`	string (UUID), 🔒 system	—	—	—	Unique ID	`”balance1”`
`local_balance.opening_booked`	Float, 🔒 system	—	—	—	Booked opening Balance in local currency	`250.00`
`local_balance.opening_value`	Float, 🔒 system	—	—	—	Value opening Balance in local currency	`250.00`
`local_balance.closing_booked`	Float, 🔒 system	—	—	—	Booked closing Balance in local currency	`250.00`
`local_balance.closing_value`	Float, 🔒 system	—	—	—	Value closing Balance in local currency	`250.00`
`local_balance.local_currency`	string (ISO 4217), 🔒 system	—	3-char code	—	Local currency of the bank account	`”EUR”`
`accounting_balance.opening_booked`	Float, 🔒 system	—	—	—	Booked opening Balance in accounting currency	`250.00`
`accounting_balance.opening_value`	Float, 🔒 system	—	—	—	Value opening Balance in accounting currency	`250.00`
`accounting_balance.closing_booked`	Float, 🔒 system	—	—	—	Booked closing Balance in accounting currency	`250.00`
`accounting_balance.closing_value`	Float, 🔒 system	—	—	—	Value closing Balance in accounting currency	`250.00`
`accounting_balance.currency`	string (ISO 4217), 🔒 system	—	3-char code	—	Currency of the accounting	`”EUR”`
`foreign_exchange.currency_rate`	number, 🔒 system	—	> 0	—	Exchange rate applied	`1.2532`
`foreign_exchange.currency_pair`	string, 🔒 system	—	6 char	—	Exchange rate currency cross applied. Also indicates side of conversion. First currency (EUR) indicates sell side	`”EURUSD”`
`foreign_exchange.currency_rate_source`	string, 🔒 system	—	max 100 chars	Enum currency rate source	Source of exchange rate. Default: `internal`	`”European Central Bank”`
`foreign_exchange.currency_rate_at`	string (ISO 8601), 🔒 system	—	ISO 8601 UTC	—	When exchange rate was applied	`”2025-06-26T14:30:00Z”`
`balance_at_from`	string (ISO 8601)	⚪ No	ISO 8601 UTC	—	Define opening datetime	`”2025-06-26T14:30:00Z”`
`balance_at_to`	string (ISO 8601)	⚪ No	ISO 8601 UTC	—	Define closing datetime. Default is datetime of the request	`”2025-06-26T14:30:00Z”`

Relationships

Name	Type	Required	Description	Example
`transactions`	to-many (transaction)	⚪ No	Transaction Resource	`[{ “type”: “transaction”, “id”: “transactionid” }]`
`workspaces`	to-many (workspace)	⚪ No	Workspace Resource	`[{ “type”: “workspace”, “id”: “workspace_tenant” }]`
`account`	to-one (payment_mean)	✅ Yes	Payment Means Resource	`{ “type”: “payment_means”, “id”: “uuid” }`

API Key Company

⌘I