latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Reports
Combines /creditScores and /creditRatings
get/reports/credits
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.
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
This is the size of the results set you would like (default: 100).
orderBystring
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-11-30T01:02:03Z"
},
"data": {
"scorePit": 800,
"score12m": 800,
"score24m": 800,
"score36m": 800,
"spRating": "AA+",
"moodysRating": "Aaa",
"fitchRating": "AA+",
"dbrsRating": "AAA",
"railzRating": "A",
"railzGrade": "Excellent",
"description": "Highest quality borrower, minimal credit risk."
}
}
]
}