Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Financial Fraud Risk

List Fraud Risk Metrics

Supported for:

freshbooks quickbooks quickbooksDesktop xero dynamicsBusinessCentral zohoBooks byod

get/v2/analytics/fraudRiskMetrics

Query parameters

connectionUuidstring required

Unique connection identifier.

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
reconstruct'true' | 'false'

Railz reconstructed Fraud Risk Metrics

Response

countnumber required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
        "businessName": "Railz",
        "serviceName": "xero",
        "reportId": "5fad8a342a88364234392fb5",
        "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
        }
      ]
    }
  ]
}