RArailz
Credit
Credit Scores

GET /creditScores

Changed on

Gets a point in time credit score based on a 1-year probability of default and 3 scores based on financial forecast and probability of default projections for a business.

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
endDatestring

The end date of the Transaction report frequency in the format: YYYY-MM-DD.

Response

countnumber required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "reportId": "5fad8a342a88364234392fb5",
        "serviceName": "xero",
        "businessName": "Railz",
        "startDate": "2020-11-25T01:02:03Z",
        "endDate": "2020-11-25T01:02:03Z",
        "createdAt": "2020-12-25T01:02:03Z",
        "updatedAt": "2020-12-25T01:02:03Z"
      },
      "data": {
        "scorePit": 800,
        "score12m": 800,
        "score24m": 800,
        "score36m": 800
      }
    }
  ]
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag Credit 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

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • warning

      deleted the query request parameter orderBy

    • warning

      deleted the query request parameter startDate

    • 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