RArailz
Reports

GET /reports/railzScore

Changed on

API to retrieve formatted credit score report

Request

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

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

The start date of the report frequency in the format: yyyy-MM-dd.

endDatestring

The end date of the report frequency in the format: yyyy-MM-dd.

Response

Successfully returned credit score

Example response

{
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "endDate": "2020-12-25T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z"
  },
  "data": {
    "score": 800,
    "rating": "Excellent",
    "lastUpdated": "2020-12-31"
  }
}

Changes

  • 5cdfae3fa1faRevision changes
    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value sandbox from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      added the new byod 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 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 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 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 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 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

    • info

      the query request parameter endDate became optional

    • info

      the query request parameter startDate became optional

    • info

      query request parameter startDate was deprecated

    • 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