Accounting Metrics
The AggregateMetric Object
Rutter performs various computations over your commerce data. The results of these computations are called aggregate metrics.
You can find the metrics we support, their corresponding metric name, and the formula used to compute them here.
Properties
start_date
stringThe starting date from which we start aggregating activity (revenue, expenses, etc).
end_date
stringThe date at which we stop aggregating activity (revenue, expenses, etc).
currency
stringIf applicable, the currency used for the value returned.
value
stringThe value of the requested metric for the time range described by the start and end date.
Fetch a Metric
The object returned will use a key matching the value of the parameter "Metric Name". It will also have a connection and checkpoint key. All other keys will be undefined.
For example, if you send a request to '/versioned/accounting/metrics/ebitda', you will receive an object with values for the keys "ebitda", "connection", and "checkpoint", nothing else.
Request Parameters
metricName
enumpathRequiredThe path of the accounting metric.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
checkpoint
stringThe ISO 8601 timestamp for the date at which the metric was last updated.
amortization_expense
arrayOptionalThe metric value and important metadata that defines the method of calculation.
amortization_expense
attributescapital_expenditure
arrayOptionalThe metric value and important metadata that defines the method of calculation.
capital_expenditure
attributescash_flow_to_debt_ratio
arrayOptionalThe metric value and important metadata that defines the method of calculation.
cash_flow_to_debt_ratio
attributeschange_in_working_capital
arrayOptionalThe metric value and important metadata that defines the method of calculation.
change_in_working_capital
attributescost_of_goods_sold
arrayOptionalThe metric value and important metadata that defines the method of calculation.
cost_of_goods_sold
attributescurrent_assets
arrayOptionalThe metric value and important metadata that defines the method of calculation.
current_assets
attributescurrent_liabilities
arrayOptionalThe metric value and important metadata that defines the method of calculation.
current_liabilities
attributescurrent_ratio
arrayOptionalThe metric value and important metadata that defines the method of calculation.
current_ratio
attributesdebt_service
arrayOptionalThe metric value and important metadata that defines the method of calculation.
debt_service
attributesdebt_service_coverage_ratio
arrayOptionalThe metric value and important metadata that defines the method of calculation.
debt_service_coverage_ratio
attributesdebt_service_from_income_statement
arrayOptionalThe metric value and important metadata that defines the method of calculation.
debt_service_from_income_statement
attributesdebt_service_from_principal_paid
arrayOptionalThe metric value and important metadata that defines the method of calculation.
debt_service_from_principal_paid
attributesdebt_to_income_ratio
arrayOptionalThe metric value and important metadata that defines the method of calculation.
debt_to_income_ratio
attributesdepreciation_expense
arrayOptionalThe metric value and important metadata that defines the method of calculation.
depreciation_expense
attributesebitda
arrayOptionalThe metric value and important metadata that defines the method of calculation.
ebitda
attributesebitda_margin
arrayOptionalThe metric value and important metadata that defines the method of calculation.
ebitda_margin
attributesenterprise_free_cash_flow
arrayOptionalThe metric value and important metadata that defines the method of calculation.
enterprise_free_cash_flow
attributesenterprise_free_cash_flow_formula_two
arrayOptionalThe metric value and important metadata that defines the method of calculation.
enterprise_free_cash_flow_formula_two
attributesgross_profit_margin
arrayOptionalThe metric value and important metadata that defines the method of calculation.
gross_profit_margin
attributesinterest_expense
arrayOptionalThe metric value and important metadata that defines the method of calculation.
interest_expense
attributesinventory
arrayOptionalThe metric value and important metadata that defines the method of calculation.
inventory
attributesnet_income
arrayOptionalThe metric value and important metadata that defines the method of calculation.
net_income
attributesnet_operating_income
arrayOptionalThe metric value and important metadata that defines the method of calculation.
net_operating_income
attributesnet_profit_margin
arrayOptionalThe metric value and important metadata that defines the method of calculation.
net_profit_margin
attributesprepaid_expenses
arrayOptionalThe metric value and important metadata that defines the method of calculation.
prepaid_expenses
attributesprincipal_paid
arrayOptionalThe metric value and important metadata that defines the method of calculation.
principal_paid
attributesquick_ratio
arrayOptionalThe metric value and important metadata that defines the method of calculation.
quick_ratio
attributesrental_expense
arrayOptionalThe metric value and important metadata that defines the method of calculation.
rental_expense
attributestotal_expenses
arrayOptionalThe metric value and important metadata that defines the method of calculation.
total_expenses
attributestotal_income
arrayOptionalThe metric value and important metadata that defines the method of calculation.
total_income
attributestotal_revenue
arrayOptionalThe metric value and important metadata that defines the method of calculation.
total_revenue
attributesunearned_revenues
arrayOptionalThe metric value and important metadata that defines the method of calculation.
unearned_revenues
attributesworking_capital
arrayOptionalThe metric value and important metadata that defines the method of calculation.
working_capital
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
Accounting Metrics Formula
Rutter supports the ability to fetch accounting metrics from an accounting connection. This can be used to compute metrics such as EBITDA without additional engineering work.
If you need a metric that is not currently supported, please contact us directly. We're happy to build new metrics as needed.
The metrics supported are listed below, along with the formula used to compute them:
Accounting Metric | Metric Name (Used as Param) | Formula |
---|---|---|
EBITDA | ebitda | Net Income + D & A + Interest |
EBITDA Margin | ebitda_margin | EBITDA / Total Income |
Net Operating Income | net_operating_income | Lifted from Income Statement |
Depreciation Expense | depreciation_expense | Sum of accounts with “depreciation” in name |
Amortization Expense | amortization_expense | Sum of accounts with “Amortization” in name |
Interest Expense | interest_expense | Sum of accounts with “interest” in name |
Gross Profit Margin | gross_profit_margin | (Total Income - Total Cost of Goods Sold) / (Total Income) |
Total Income | total_income | Lifted from income statement |
Cost of Goods Sold | cost_of_goods_sold | Lifted from income statement |
Net Income | net_income | Lifted from income statement |
Current Ratio | current_ratio | Current Assets / Current Liabilities |
Working Capital | working_capital | Current Assets - Current Liabilities |
Current Liabilities | current_liabilities | Lifted from Balance Sheet |
Current Assets | current_assets | Lifted from Balance Sheets |
Quick Ratio | quick_ratio | (Current Assets - Total Inventory - Total Prepaid Expenses) / (Current Liabilities - Total Unearned Revenue) |
Inventory | inventory | Sum of asset accounts with “Inventory” in name |
Unearned Revenues | unearned_revenues | Sum of Liability Accounts with “Unearned Revenue” in name |
Prepaid Expenses | prepaid_expenses | Sum of asset accounts with “Prepaid” in name |
Enterprise Free Cash Flow | enterprise_free_cash_flow | Net Income + Change in working Capital + Capex + interest expense * (1 - tax rate) + D&A |
Change in working Capital | change_in_working_capital | Working capital of current period - working capital of prior period |
Capex | capital_expenditure | Total Investing Activity from Cash flow Statement |
Debt Service Coverage Ratio | debt_service_coverage_ratio | Enterprise Free Cash Flow / Total Debt Service |
Debt Service | debt_service | Interest Paid from income statement + Rental Expense + Principal Paid |
Have questions?
Contact support for personalized guidance.