Contracting & Hierarchies API

AssignedCarrierV2Page

object

A token-paginated page of assigned carriers (plain envelope, no HAL wrappers).

itemsarray[object]required

A carrier assigned to the calling customer’s account.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

AssignedProductAnnualizationV2

object

An annualization option available on an assigned product.

idstring(uuid)
proportionnumber

The annualization proportion.

namestring

The human-readable annualization label.

Example

AssignedProductV2

object

A product assigned to the calling customer’s account.

idstring(uuid)required
namestringrequired
organizationIdstring(uuid)

The owning carrier organization’s id.

organizationNamestring

The owning carrier organization’s name (inlined).

lineOfBusinessIdstring(uuid)
lineOfBusinessNamestring

The line of business (inlined).

submissionMethodIdstring(uuid)
submissionMethodNamestring

The submission method (inlined).

annualizationTypestring
maxAnnualizationAmountnumber
annualizationExpirystring(date)
annualizationsarray[object]

An annualization option available on an assigned product.

Show Child Parameters
expirystring(date)
expiredboolean

Whether the product is past its expiry date.

displayCommissionLevelPercentagesboolean
userDefined1string
userDefined2string
userDefined3string
userDefined4string
userDefined5string
userDefined6string
userDefined7string
userDefined8string
userDefined9string
userDefined10string
createdAtstring(date-time)

RFC3339 UTC creation timestamp.

updatedAtstring(date-time)

RFC3339 UTC last-modified timestamp.

Example

AssignedProductV2Page

object

A token-paginated page of assigned products (plain envelope, no HAL wrappers).

itemsarray[object]required

A product assigned to the calling customer’s account.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

AssignedCommissionLevelV2

object

A commission level assigned to the calling customer, with its product and carrier context.

idstring(uuid)required

Stable identifier for this assignment row.

commissionLevelIdstring(uuid)required
commissionLevelNamestring
typestring

The commission level type.

Allowed values:PercentDollarNumber

firstYearValuenumber
levelnumber
renewalPercentagenumber
renewalNamestring
productIdstring(uuid)
productNamestring
carrierOrganizationIdstring(uuid)
carrierOrganizationNamestring
activeboolean

Whether the commission-level assignment is active.

createdAtstring(date-time)

RFC3339 UTC creation timestamp.

updatedAtstring(date-time)

RFC3339 UTC last-modified timestamp.

Example