Accounts

Overview

These endpoints support creating and managing GL accounts.

Updates and deletes follow a last-saved-wins model. Updating an account replaces existing data without warnings. Updating a deleted account returns an error.

Institution settings (impact on balances)

Some account balance behaviors depend on institution-level configuration. The two primary settings are:

• firstFiscalMonth — integer (1–12). Determines the institution’s fiscal year start and affects YTD/QTD/MTD calculations.
• priorMonthEffectiveDateLimit — integer (0–31). Controls how far transactions may be effective-dated into the prior month, which affects month-ending and monthly balance calculations.

These values are managed by the Institution Settings API. For full contract details and validation rules, see the Institution Settings API reference and the Accounts API documentation:

• Institution Settings API Reference
• Accounts API reference

Keep institution settings in mind when interpreting historical balances and when back-dating transactions; coordinate changes to these settings with reporting owners to avoid unexpected balance shifts.

Daily Balances

Daily balances are available for each GL account.

Balances update as transactions post. If not activity occurs on a given day, end-of-day processing creates a daily balance using the prior day’s balance.

Monthly Averages

Monthly average balances are available for each GL account.

The response includes:

• The current fiscal year
• The prior year
• Two years ago

Completed months return calculated averages. Future months return 0.

Calculation

• Monthly average = sum of daily balances ÷ numbers of days included
• For the current month, the divisor includes today

runDate

• Optional query parameter (any valid date)
• Invalid formats return an error
• When provided, results are returned for the fiscal year of runDate and the prior two years
• Defaults to the current UTC date

Quarterly Averages

Quarterly average balances are available for each GL account.

The response includes:

• The current fiscal year
• The prior year
• Two years ago

Completed quarters return averages. The current quarter returns a quarter-to-date average. Future quarters return 0.

Calculation

• Quarterly average = sum of daily balances ÷ number of days included
• For the current quarter, the divisor includes today

runDate

• Optional
• Behaves the same as Monthly Averages

Year-To-Date Averages

Year-to-date (YTD) average balances are available for:

• The current year
• The prior year
• Two years ago

Calculation

• YTD average = sum of daily balances from the first fiscal month through today ÷ number of days included
• Prior years use the same number of days (except leap years)

runDate

• Optional
• Behaves the same as Monthly Averages

Month Ending Balances

Month-ending balances represent the daily balance on the last day of each month.

The response includes:

• The current fiscal year
• The prior year
• Two years ago

Completed months return balances. Future months return 0.

Behavior

• If the fiscal year has just started, prior two years return full data and the current year returns zeros
• If the current month has not ended, its value is 0

runDate

• Optional
• If runDate is the last day of a month, that month is included
• Defaults to the current UTC date

Quarter Ending Balances

Quarter-ending balances represent the daily balance on the last day of each quarter.

The response includes:

• The current fiscal year
• The prior year
• Two years ago

Completed quarters return balances. The current quarter does not.

Behavior

• If the fiscal year has just started, only prior quarters return balances
• Future quarters return 0

runDate

• Optional
• If runDate is the last day of a quarter, that quarter is included
• Defaults to the current UTC date

Month-to-Date Balances

Month-to-date (MTD) balances represent the change in balance within each month.

Calculation

• Past months: month-ending balance − prior month-ending balance
• Current month: current balance − prior month-ending balance

Account Type Rules

• Income / Expense
  • First fiscal month: MTD equals current balance
  • After the first month ends: MTD equals the month-ending balance
• Asset / Liability / Equity
  • Always use the prior month-ending balance

runDate

• Optional
• Returns data for the fiscal year of runDate and the prior two years
• Defaults to the current UTC date

Quarter-to-Date Balances

Quarter-to-date (QTD) balances represent the change in balance within each quarter.

Calculation

• Past quarters: quarter-ending balance − prior quarter-ending balance
• Current quarter: current balance − prior quarter-ending balance

Account Type Rules

• Income / Expense
  • First fiscal quarter: QTD equals current balance
  • After the quarter ends: QTD equals the quarter-ending balance
• Asset / Liability / Equity
  • Always use the prior quarter-ending balance

runDate

• Optional
• Behaves the same as Month-to-Date Balances

Year-to-Date Balances

Year-to-date (YTD) balances represent the change in balance since the start of the fiscal year.

Calculation

• Asset / Liability / Equity
  • Current balance − prior year-ending balance
• Income / Expense
  • Daily balance for the given date

runDate

• Optional
• Returns results for the fiscal year of runDate and the prior two years
• Defaults to the current UTC date