Contracting & Hierarchies API

AvailableUplineChangeV2Page

object

A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).

itemsarray[object]required

A contract-assignment change eligible to be selected as an upline, scoped to a
contract-assignment or contract-assignment-change.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

ResponsibleUplineFirmV2

object

A firm responsible for upline relationships in an organization.

idstring(uuid)required
namestring
npnstring
feinstring
testAccountboolean
Example

ResponsibleUplineFirmV2Page

object

A token-paginated page of responsible upline firms (plain envelope, no HAL wrappers).

itemsarray[object]required

A firm responsible for upline relationships in an organization.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

ContractAssignmentV2

object

A producer’s assignment to a carrier product, with its commission level and status.

idstring(uuid)required

The contract assignment id.

contractIdstring(uuid)required

The parent contract id.

agencyOrganizationIdstring(uuid)required

The agency organization the assignment is sent from.

carrierOrganizationIdstring(uuid)required

The carrier organization the assignment is sent to.

personIdstring(uuid)required

The individual producer the assignment is on behalf of.

firmIdstring(uuid)

The firm the assignment is on behalf of, if any.

productIdstring(uuid)required
productNamestring

The product name (inlined so no follow-up lookup is needed).

commissionLevelIdstring(uuid)required
commissionLevelNamestring

The commission level name (inlined).

assignmentStatusIdstring(uuid)
assignmentStatusNamestring

The human-readable assignment status (the event names this assignmentStatus).

displayNumberstringrequired

The human-readable assignment number.

writingNumberstring
effectiveOnstring(date)

The effective date (yyyy-MM-dd).

requestedEffectiveOnstring(date)

The requested effective date (yyyy-MM-dd).

expiresOnstring(date)

The expiration date (yyyy-MM-dd). Renamed from the entity’s expiry.

responsiblePartyIdstring(uuid)
responsibleUplineFirmIdstring(uuid)
responsiblePartyStartOnstring(date)
responsiblePartyEndOnstring(date)
referralCodesarray[string]
debitBalancenumber
externalNotesstring
uplineContractAssignmentobject

Identity of the assignment’s upline, surfaced as part of the caller’s own hierarchy.

Show Child Parameters
createdAtstring(date-time)

RFC3339 UTC creation timestamp.

updatedAtstring(date-time)

RFC3339 UTC last-modified timestamp.

userDefined1string
userDefined2string
userDefined3string
userDefined4string
userDefined5string
userDefined6string
userDefined7string
userDefined8string
userDefined9string
userDefined10string
Example

ContractAssignmentV2Page

object

A token-paginated page of contract assignments (plain envelope, no HAL wrappers).

itemsarray[object]required

A producer’s assignment to a carrier product, with its commission level and status.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example