Contracting & Hierarchies API

AvailableUplineV2Page

object

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

itemsarray[object]required

A currently-approved contract assignment eligible to be selected as an upline.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

AvailableUplineChangeV2

object

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

contractAssignmentChangeIdstring(uuid)required
contractAssignmentIdstring(uuid)
firstNamestring
lastNamestring
suffixstring
firmIdstring(uuid)
firmNamestring

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

personIdstring(uuid)
fromOrganizationIdstring(uuid)
npnstring
writingNumberstring
levelOfCommissionnumber
annualizationProportionnumber
productIdstring(uuid)
testAccountboolean
startDatestring(date)
endDatestring(date)
commissionLevelNamestring
contractAssignmentChangeDisplayNumberstring
Example

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