Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Credit Scores

List Credit Scores

Supported for:

freshbooks quickbooks quickbooksDesktop xero dynamicsBusinessCentral zohoBooks byod

get/v2/analytics/creditScores

Query parameters

connectionUuidstring required

Unique connection identifier.

endDatestring

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

reconstruct'true' | 'false'

Railz reconstructed Credit Score.

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