Sign in
Balances

Retrieves a list of available balance definitions.

get/api/balances/definitions

Response

OK

Idinteger
CompanyIdinteger nullable
CountryIdinteger nullable
Namestring
SpecialIdentifierstring
IsConfigurableboolean
AmountEnabledboolean
TaxEnabledboolean
SecondaryAmountEnabledboolean
TertiaryAmountEnabledboolean
DaysEnabledboolean
SecondaryDaysEnabledboolean
HoursEnabledboolean
BaseAmountEnabledboolean
HasPeriodsboolean
SuspendedDaysEnabledboolean
IsActiveboolean
BaseCalculationMethodIdinteger nullable
BalanceEarningIntervalIdinteger nullable
UnitsEarnedPerIntervalnumber double nullable
EarningFixedAmountnumber double nullable
EarningPercentagenumber double nullable
TerminationMethodIdinteger nullable
SpendingMethodIdinteger nullable

Changes

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