latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Credit Scores
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.
get/creditScores
Query parameters
businessNamestring required
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
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
}
}
]
}