ContractResponsiblePartyV2
objectOne responsible-party window on a contract. Both bounds are inclusive. Windows do not overlap, with
two exceptions: two windows may meet on a single shared day (one window’s endDate equal to the
next window’s startDate), and a window whose startDate equals its endDate is a retired record
rather than a live one-day assignment. To resolve who is responsible on a given day, ignore windows
where startDate equals endDate, and on a shared boundary day prefer the window that starts that
day over the one that ends it. The current window is the one with no endDate; there is at most one
per contract.
The responsible-party window id.
The person responsible for the contract during this window.
The first day the responsible party is responsible (yyyy-MM-dd).
The last day the responsible party is responsible (yyyy-MM-dd). Absent on the current,
open-ended window.
ProducerV2
objectA producer in the calling customer’s organization. A producer is either an individual
(type = AGENT, identified by personId) or a firm (type = FIRM, identified by
firmId); fields that do not apply to the other kind are null.
The producer kind.
Allowed values:AGENTFIRM
The individual’s id (null for firms).
The firm’s id (null for individuals).
The individual’s first name (null for firms).
The individual’s middle name (null for firms). On this list item it comes from the
contracting record’s own copy, which can lag the Identity API; the by-id endpoint reads
it live.
The individual’s last name (null for firms).
The firm’s name (null for individuals).
National Producer Number.
The individual’s email (null for firms).
The human-readable producer status (inlined). Null for firms, which carry no status.
Whether the producer is active. Always true for firms.
RFC3339 UTC creation timestamp.
RFC3339 UTC last-modified timestamp.
ProducerV2Page
objectA token-paginated page of producers (plain envelope, no HAL wrappers).
A producer in the calling customer’s organization. A producer is either an individual
(type = AGENT, identified by personId) or a firm (type = FIRM, identified by
firmId); fields that do not apply to the other kind are null.
Show Child Parameters
Pagination metadata for a V2 list response.
Show Child Parameters
ProducerDetailV2
A single producer in the calling customer’s organization. Carries the same fields as the list
item plus phones, federatedUsername, and bankAccounts, and serves a live middleName.
Personal and demographic details such as date of birth, SSN, and addresses are not part of a
contracting record and are retrieved from the Identity API.
The producer kind.
Allowed values:AGENTFIRM
The individual’s id (null for firms).
The firm’s id (null for individuals).
The individual’s first name (null for firms).
The individual’s middle name (null for firms), read live from the Identity API so it
is current even when the contracting record’s own copy has not caught up.
The individual’s last name (null for firms).
The firm’s name (null for individuals).
National Producer Number.
The individual’s email (null for firms).
The human-readable producer status (inlined). Null for firms, which carry no status.
Whether the producer is active. Always true for firms.
RFC3339 UTC creation timestamp.
RFC3339 UTC last-modified timestamp.
A producer’s bank account. The account and routing numbers are masked to ****<last4>.
Show Child Parameters
A producer’s phone number.
Show Child Parameters
The producer’s federated login username for the calling customer. Null when the
producer has no federated login, and always null for firms.
ProducerPhoneV2
objectA producer’s phone number.
Example:5551234567
The phone kind.
Allowed values:CELLBUSINESSRESIDENTFAX
Whether this is the producer’s preferred number.