Designation Accounts
Designation Accounts Documentation
Designation Account [GET]
Designation Account [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
active
Type
boolean
Description If this designation_account is active then the balance should be added into the profile total
balance
Type
number
Description The balance in its native currency
balance_updated_at
Type
string
Description The DateTime when the balance was updated
converted_balance
Type
number
Description The balance in the account_list default currency
created_at
Type
date
Description The timestamp of when this resource was created
currency
Type
string
Description The native currency of the designation_account
currency_symbol
Type
string
Description The native currency symbol of the designation_account
designation_number
Type
string
Description The remote system designation number
display_name
Type
string
Description The name to display
exchange_rate
Type
number
Description The exchange rate from the native currency to the account_list default currency
legacy_designation_number
Type
-
Description The legacy remote system designation number
name
Type
float
Description The name of the designation
organization_name
Type
string
Description The name of the organization this designation belongs to
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
balances.data
Type
[Balance]
Description Balance changes to the designation account over time
organization.data
Type
Organization
Description The Organization the designation account belongs to
Last updated