HierarchyNodeV2
objectA node in an organization’s contract-assignment hierarchy, decoupled from the internal
Contracting domain models. The node key is contractAssignmentId; uplineContractAssignmentId
links to the parent node and is null on root nodes. Reference names are inlined next to
their ids. active is computed over the tree — a node is inactive when its own status is
inactive or any node above it is. A node represents either an individual (type = AGENT,
identified by personId) or a firm (type = FIRM, identified by firmId); the
identifier that does not apply to the node’s kind is null.
The node’s key — the stable identity of a producer’s placement for a product.
The parent node’s contractAssignmentId, or null for root nodes.
The producer or organization at this position.
The producer kind at this position. Null when the position identifies neither an
individual nor a firm.
Allowed values:AGENTFIRM
The individual’s id (null for firms).
The firm’s id (null for individuals).
National Producer Number of the individual or firm at this position.
The product name (inlined so no follow-up lookup is needed).
The carrier organization the assignment is sent to. Matches the
carrierOrganizationId reported for the same assignment by the contracts,
contract-assignments and contract-assignment-changes endpoints.
The carrier organization name (inlined so no follow-up lookup is needed).
The human-readable assignment status (inlined).
The commission level name (inlined).
The commission level’s numeric value.
States this position is contracted for.
Carrier-assigned writing number, if applicable.
The assignment’s contractual effective date (yyyy-MM-dd).
The assignment’s contractual expiration date (yyyy-MM-dd).
Whether this position is active, computed over the tree.
The partnership holding this contract, when its commission is split across partnership
members. Absent on nodes whose contract is held by a single producer.
The partnership’s name (inlined). Absent when the node has no partnership.
Whether the partnership is still current. A dissolved partnership is still reported —
its splits are what explain an in-force assignment’s commission — so use this flag
rather than the presence of commissionSplits to tell whether the arrangement is
active. Always absent when the node has no partnership, and may be absent even when it
does if the partnership’s state was never recorded; treat absent as unknown rather than
as inactive.
One partnership member’s share of the commission earned on a hierarchy node. Splits are not
effective-dated internally, so — unlike the rest of the node — they reflect the
partnership’s current state rather than the requested as_of date.
Show Child Parameters
CommissionSplitV2
objectOne partnership member’s share of the commission earned on a hierarchy node. Splits are not
effective-dated internally, so — unlike the rest of the node — they reflect the
partnership’s current state rather than the requested as_of date.
The member this share belongs to.
The member’s name (inlined). Partnership members are always individuals.
The member’s share as a proportion in [0, 1] — a 60/40 split is reported as 0.60
and 0.40. The shares of a fully-allocated partnership sum to exactly 1, but this is
not guaranteed: only an upper bound of 100% is enforced internally, so a partially
allocated partnership’s shares sum to less than 1.
Example:0.6
Whether this is the partnership’s primary partner. Exactly one member is primary, and
it is listed first.
HierarchyNodeV2Page
objectA token-paginated page of hierarchy nodes (plain envelope, no HAL wrappers).
A node in an organization’s contract-assignment hierarchy, decoupled from the internal
Contracting domain models. The node key is contractAssignmentId; uplineContractAssignmentId
links to the parent node and is null on root nodes. Reference names are inlined next to
their ids. active is computed over the tree — a node is inactive when its own status is
inactive or any node above it is. A node represents either an individual (type = AGENT,
identified by personId) or a firm (type = FIRM, identified by firmId); the
identifier that does not apply to the node’s kind is null.
Show Child Parameters
Pagination metadata for a V2 list response.
Show Child Parameters
PageInfo
objectPagination metadata for a V2 list response.
Number of items returned in this response (equal to items.length).
Opaque continuation token for the next page, or null on the last page.
ApiError
objectThe AgentSync error shape.
A human-readable description of the error.
Optional field-level details.