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.
Show Child Parameters
WebhookEventEnvelope
objectCommon wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated