GET/v1/definitions/{key}/rows/{rowId}/bank-statements

List a record's bank statements

One deal's bank statements as the processor read them: each file with the months extracted from it — revenue, deposits, average daily balance, NSFs, the positions found in it and the reasoning behind each figure — and the rollup those months add up to. get_definitions_key_rows_rowId_statements is the other half: the files and spans a person filed, without any of this arithmetic. Deals page only.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

rowIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

:rowIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "extractions": [
        "string"
      ],
      "fileId": "",
      "fileName": "string",
      "jobId": "",
      "periods": [
        "string"
      ],
      "rollup": {
        "avgDailyBalanceMinor": "string",
        "avgDepositsMinor": "string",
        "avgRevenueMinor": "string",
        "months": "string",
        "negativeDays": "string",
        "nsfCount": "string",
        "positions": "string"
      },
      "uploadedAt": "string"
    }
  ]
}

dataarray<>optional

defaultapplication/json

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

errorstringrequired