latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Financial Fraud Risk
Gets the financial fraud risk metrics for a business based on benford's law.
get/fraudRiskMetrics
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.
startDatestring
The start date of the Transaction report frequency in the format: YYYY-MM-DD.
endDatestring
The end date of the Transaction report frequency in the format: YYYY-MM-DD.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
reportFrequency'month' | 'quarter' | 'year' required
Response
Example response
{
"count": 1,
"reports": [
{
"meta": {
"reportId": "5fad8a342a88364234392fb5",
"serviceName": "xero",
"businessName": "Railz",
"startDate": "2020-11-01T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z",
"createdAt": "2020-11-30T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z"
},
"data": [
{
"benfordLawScore": 20.92,
"outlierScore": 0.659176337,
"outlierRatio": 0.093829111,
"outlierTransactions": [
{
"id": "nt"
}
],
"transactionKeywords": [
{
"type": "bill",
"count": 1
}
],
"transactionsSectionStats": [
{
"section": "Expenses",
"count": 4,
"sdev": 39.82
}
],
"transactionPatterns": [
{
"repetitionPattern": "Accounts Payables 113.71",
"count": 3
}
],
"currentRatioDelta": 1,
"quickRatioDelta": 1,
"debtToEquityRatioDelta": 1,
"netProfitMarginRatioDelta": 1
}
]
}
]
}