Contracting & Hierarchies API

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

UplineContractAssignmentChangeV2

object

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

idstring(uuid)required

The upline contract assignment change id.

displayNumberstring

The upline change’s human-readable number.

firmNamestring

The upline’s firm name, if the upline is a firm.

personNamestring

The upline’s person name, if the upline is an individual producer.

Example

ContractAssignmentChangeV2

object

A point-in-time change to a contract assignment. assignmentStatus* is the change’s own
status. effectiveOn/expiresOn are the assignment’s contractual terms, while
snapshotStartOn/snapshotEndOn are the window during which this change represented the
assignment’s state.

idstring(uuid)required

The contract assignment change id.

contractAssignmentIdstring(uuid)required

The assignment this change applies to.

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).

assignmentStatusIdstring(uuid)

The change’s status.

assignmentStatusNamestring

The human-readable change status (inlined).

newCommissionLevelIdstring(uuid)
newCommissionLevelNamestring

The new commission level name (inlined).

newAnnualizationIdstring(uuid)
contractPacketIdstring(uuid)
taskTypeNamestring

The task type intended by this change.

displayNumberstringrequired

The human-readable change number.

writingNumberstring
effectiveOnstring(date)

The assignment’s contractual effective date (yyyy-MM-dd).

expiresOnstring(date)

The assignment’s contractual expiration date (yyyy-MM-dd).

snapshotStartOnstring(date)

Start of the window this change represented the assignment’s state (yyyy-MM-dd).

snapshotEndOnstring(date)

End of the window this change represented the assignment’s state (yyyy-MM-dd).

referralCodesarray[string]
titlestring
externalNotesstring
uplineContractAssignmentChangeobject

Identity of the change’s upline change, 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

ContractAssignmentChangeV2Page

object

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

itemsarray[object]required

A point-in-time change to a contract assignment. assignmentStatus* is the change’s own
status. effectiveOn/expiresOn are the assignment’s contractual terms, while
snapshotStartOn/snapshotEndOn are the window during which this change represented the
assignment’s state.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example