latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Reports
API to retrieve formatted financial ratios report
get/reports/financialRatios
Query parameters
businessNamestring required
Unique business name identifier.
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'zohoBooks' | 'byod' required
Name of accounting service provider, reuse currently available enum used in the feeder
startDatestring required
The start date of the report frequency in the format: yyyy-MM-dd.
endDatestring required
The end date of the report frequency in the format: yyyy-MM-dd.
reportFrequency'month' | 'quarter' | 'year' required
The report snapshot frequency.
Response
Successfully returned financial ratios
Example response
{
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"endDate": "2020-12-25T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"reportFrequency": "month"
},
"data": {
"credit": {
"distanceToDefault": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"probabilityOfDefault": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"liquidationValue": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
}
},
"efficiency": {
"grossBurnRate": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"inventoryTurnoverRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"assetTurnoverRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
}
},
"leverage": {
"equityToLTAssets": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"shortDebtToEquityRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"debtToEquityRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"interestBankLoan": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"interestCoverageRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"debtToAssetsRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"debtServiceCoverageRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
}
},
"liquidity": {
"quickRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"absoluteLiquidity": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"currentRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"grossBurn": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"runway": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"cashRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"freeCashflowRatio": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
}
},
"profitability": {
"returnOnAssets": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"ebitda": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"ebitdaMargin": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"workingCapital": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"freeCashFlow": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"grossMargin": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"netProfitMargin": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"operatingMargin": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"returnOnEquity": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
},
"revenueConcentrationIndex": {
"currentValue": 10,
"percentageChange": 10,
"timePeriodData": [
{
"period": {
"year": 2020,
"month": 8,
"quarter": 3,
"day": 31,
"date": "2020-08-31T00:00:00.000Z"
},
"value": 1000
}
]
}
}
}
}