Browse the extensions reference

flowCandidates

returns [FlowCandidate!]!

The cash flow rows a line may be tagged with.

A flow is a second classification beside the account: it overrides the account's default flow on the cash flow and equity statements (a bank line's classified_flow_qname, a journal-entry line's transaction_description_code). These are the leaf investing and financing rows of the entity's cash flow statement under its Reporting Style - the set the write path accepts - so a picker built from them never offers a row the statement cannot present. By section, investing then financing, and by name within each.

Arguments

NameTypeDescription
entityIdStringThe entity whose statement the rows come from. Omit for the group parent.

Returns FlowCandidate

A cash flow row a line may be tagged with: the flow that overrides the account's default on the cash flow and equity statements.

FieldTypeDescription
elementIdString!The flow concept's element id.
qnameString!The flow's qname, the value a bank line's classified_flow_qname and a journal-entry line's transaction_description_code take.
nameString!The flow's name, as the statement labels its row.
activityString!investing or financing: the section of the statement the row sits in.

Example

query
{ flowCandidates { elementId qname name activity } }
curl
curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ flowCandidates { elementId qname name activity } }"}'