/v1/definitions/{key}/rows/{rowId}/financialsRead a record's financials
The deal Highlights' summary: monthly revenue, average daily balance, NSFs, positions and the score, each named with the job it came from. Computed from the same extracted months the statements tab shows, with the same arithmetic, so a headline cannot disagree with the table under it. A deal nothing has been read for answers empty job ids rather than a 404 — 'not processed' is a state. Deals page only.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"banking": {
"averageDailyBalanceMinor": 1,
"currency": "string",
"files": 1,
"jobId": "",
"monthlyRevenueMinor": 1,
"months": 1,
"nsfCount": 1,
"positions": 1
},
"credit": {
"bureau": "string",
"jobId": "",
"pulledAt": "string",
"score": 1,
"scoreSource": "string"
}
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}