allocationShare

returns AllocationShare

The outside owners' share of a member's result for one month.

The pro-rata figure its ownership gives, the override set with set-allocation-override if any, and the share the consolidating entries use. Null for an entity that is not a member consolidated in full that month: its outside owners have no share the engine allocates.

Arguments

Name	Type	Description
entityId	String!	The member.
period	String!	The month, as YYYY-MM.

Returns AllocationShare

The outside owners' share of a member's result for one month: the pro-rata figure its ownership gives, the override that replaces it if one is set, and the share the consolidating entries use.

Field	Type	Description
entityId	String!	The member.
entityName	String!	The member's name.
period	String!	The month, as YYYY-MM.
consolidationMethod	String!	How the member is consolidated: full, equity, cost or none.
ownershipPct	Float	The parent's ownership, as a percentage.
outsidePct	Float!	The outside owners' ownership, as a percentage.
monthResult	Int!	Cents: the member's result for the month, positive for a profit.
proRataAmount	Int!	Cents: the outside owners' percentage of the month's result.
override	AllocationOverrideRecord	The month's override, when one is set.
effectiveAmount	Int!	Cents: the share the consolidating entries use, the override's when set.
closed	Boolean!	True when the consolidation entity has closed the month, so the override can no longer change.

Example

query

{ allocationShare(entityId: "...", period: "...") { entityId entityName period consolidationMethod } }

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": "{ allocationShare(entityId: \"...\", period: \"...\") { entityId entityName period consolidationMethod } }"}'