RArailz
FinancialFraudRisk
Financial Fraud Risk

GET /fraudRiskMetrics

Changed on

Gets the financial fraud risk metrics for a business based on benford's law.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
Example:Railz

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
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
reportFrequency'month' | 'quarter' | 'year' required

Response

countnumber required

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
        }
      ]
    }
  ]
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag FinancialFraudRisk added

  • 5cdfae3fa1faRevision changes
    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value plaid from the query request parameter serviceName

    • breaking

      removed the enum value shopify from the query request parameter serviceName

    • breaking

      removed the enum value square from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • info

      added the new enum value byod to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName