POST
/
v1
/
cash-flow-statement
/
query
Cash Flow Statement
curl --request POST \
  --url https://api.bigdata.com/v1/cash-flow-statement/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "identifier": {
    "type": "rp_entity_id",
    "value": "4A6F00"
  },
  "period": "annual",
  "limit": 123
}'
{
  "results": "<any>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "pagination": {
    "cursor": "00000DexaRK4NT6t",
    "has_cursor": true
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
object
required

Object specifying which identifier you are using to request the cash flow statement. You must supply one type and its corresponding value.

period
enum<string>

Select whether the cash flow statement to be provided are on an annual or quarterly basis.

Available options:
annual,
quarter
limit
integer | null

Maximum number of cash flow statements to return. If omitted, all cash flow statements are returned.

Response

200 - application/json

Successful Response

results
required
errors
ErrorDetail · object[] | null
pagination
object | null

Common pagination response for endpoints that support pagination.

metadata
object | null