API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Entities

List all entities

client.Entities.List(ctx, query) (*CursorPagination[Entity], error)

GET/entities

Delete an entity

client.Entities.Delete(ctx, id) error

DELETE/entities/{id}

Get an entity by ID

client.Entities.Get(ctx, id) (*Entity, error)

GET/entities/{id}

ModelsExpand Collapse

type Entity struct{…}

ID string

Unique identifier with entity_ prefix

CreatedAt Time

Timestamp when the entity was created

formatdate-time

DisplayName string

Display name of the entity

HouseholdID string

Household ID this entity belongs to

InEstateStatus EntityInEstateStatus

Whether the entity is in or out of the estate

One of the following:

const EntityInEstateStatusInEstate EntityInEstateStatus = "in_estate"

const EntityInEstateStatusOutOfEstate EntityInEstateStatus = "out_of_estate"

const EntityInEstateStatusNone EntityInEstateStatus = "none"

Kind EntityKind

Type of entity - determines the specific subtype and applicable fields

One of the following:

const EntityKindRevocableTrust EntityKind = "REVOCABLE_TRUST"

const EntityKindIrrevocableTrust EntityKind = "IRREVOCABLE_TRUST"

const EntityKindSlatTrust EntityKind = "SLAT_TRUST"

const EntityKindIlitTrust EntityKind = "ILIT_TRUST"

const EntityKindQprtTrust EntityKind = "QPRT_TRUST"

const EntityKindGratTrust EntityKind = "GRAT_TRUST"

const EntityKindCrtTrust EntityKind = "CRT_TRUST"

const EntityKindCltTrust EntityKind = "CLT_TRUST"

const EntityKindIndividualPersonalAccount EntityKind = "INDIVIDUAL_PERSONAL_ACCOUNT"

const EntityKindJointPersonalAccount EntityKind = "JOINT_PERSONAL_ACCOUNT"

const EntityKindCustodialPersonalAccount EntityKind = "CUSTODIAL_PERSONAL_ACCOUNT"

const EntityKindInsurancePersonalAccount EntityKind = "INSURANCE_PERSONAL_ACCOUNT"

const EntityKindQualifiedTuitionPersonalAccount EntityKind = "QUALIFIED_TUITION_PERSONAL_ACCOUNT"

const EntityKindRetirementPersonalAccount EntityKind = "RETIREMENT_PERSONAL_ACCOUNT"

const EntityKindDonorAdvisedFund EntityKind = "DONOR_ADVISED_FUND"

const EntityKindPrivateFoundation EntityKind = "PRIVATE_FOUNDATION"

const EntityKindLlcBusinessEntity EntityKind = "LLC_BUSINESS_ENTITY"

const EntityKindLpBusinessEntity EntityKind = "LP_BUSINESS_ENTITY"

const EntityKindGpBusinessEntity EntityKind = "GP_BUSINESS_ENTITY"

const EntityKindSoleProprietorshipBusinessEntity EntityKind = "SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"

const EntityKindScorpBusinessEntity EntityKind = "SCORP_BUSINESS_ENTITY"

const EntityKindCcorpBusinessEntity EntityKind = "CCORP_BUSINESS_ENTITY"

Stage EntityStage

Lifecycle stage of the entity

One of the following:

const EntityStagePreCreated EntityStage = "PRE_CREATED"

const EntityStageAICreating EntityStage = "AI_CREATING"

const EntityStageAICreationFailed EntityStage = "AI_CREATION_FAILED"

const EntityStageAINeedsReview EntityStage = "AI_NEEDS_REVIEW"

const EntityStageDraft EntityStage = "DRAFT"

const EntityStageReadyForProposal EntityStage = "READY_FOR_PROPOSAL"

const EntityStageImplementation EntityStage = "IMPLEMENTATION"

const EntityStageActive EntityStage = "ACTIVE"

const EntityStageCompleted EntityStage = "COMPLETED"

const EntityStageArchived EntityStage = "ARCHIVED"

UpdatedAt Time

Timestamp when the entity was last updated

formatdate-time

ExternalID stringOptional

Customer-supplied identifier from an external system. Unique within the caller’s tenant when set.

minLength1

type EntityKind string

Type of entity - determines the specific subtype and applicable fields

One of the following:

const EntityKindRevocableTrust EntityKind = "REVOCABLE_TRUST"

const EntityKindIrrevocableTrust EntityKind = "IRREVOCABLE_TRUST"

const EntityKindSlatTrust EntityKind = "SLAT_TRUST"

const EntityKindIlitTrust EntityKind = "ILIT_TRUST"

const EntityKindQprtTrust EntityKind = "QPRT_TRUST"

const EntityKindGratTrust EntityKind = "GRAT_TRUST"

const EntityKindCrtTrust EntityKind = "CRT_TRUST"

const EntityKindCltTrust EntityKind = "CLT_TRUST"

const EntityKindIndividualPersonalAccount EntityKind = "INDIVIDUAL_PERSONAL_ACCOUNT"

const EntityKindJointPersonalAccount EntityKind = "JOINT_PERSONAL_ACCOUNT"

const EntityKindCustodialPersonalAccount EntityKind = "CUSTODIAL_PERSONAL_ACCOUNT"

const EntityKindInsurancePersonalAccount EntityKind = "INSURANCE_PERSONAL_ACCOUNT"

const EntityKindQualifiedTuitionPersonalAccount EntityKind = "QUALIFIED_TUITION_PERSONAL_ACCOUNT"

const EntityKindRetirementPersonalAccount EntityKind = "RETIREMENT_PERSONAL_ACCOUNT"

const EntityKindDonorAdvisedFund EntityKind = "DONOR_ADVISED_FUND"

const EntityKindPrivateFoundation EntityKind = "PRIVATE_FOUNDATION"

const EntityKindLlcBusinessEntity EntityKind = "LLC_BUSINESS_ENTITY"

const EntityKindLpBusinessEntity EntityKind = "LP_BUSINESS_ENTITY"

const EntityKindGpBusinessEntity EntityKind = "GP_BUSINESS_ENTITY"

const EntityKindSoleProprietorshipBusinessEntity EntityKind = "SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"

const EntityKindScorpBusinessEntity EntityKind = "SCORP_BUSINESS_ENTITY"

const EntityKindCcorpBusinessEntity EntityKind = "CCORP_BUSINESS_ENTITY"

type EntityList struct{…}

Data []Entity

ID string

Unique identifier with entity_ prefix

CreatedAt Time

Timestamp when the entity was created

formatdate-time

DisplayName string

Display name of the entity

HouseholdID string

Household ID this entity belongs to

InEstateStatus EntityInEstateStatus

Whether the entity is in or out of the estate

One of the following:

const EntityInEstateStatusInEstate EntityInEstateStatus = "in_estate"

const EntityInEstateStatusOutOfEstate EntityInEstateStatus = "out_of_estate"

const EntityInEstateStatusNone EntityInEstateStatus = "none"

Kind EntityKind

Type of entity - determines the specific subtype and applicable fields

One of the following:

const EntityKindRevocableTrust EntityKind = "REVOCABLE_TRUST"

const EntityKindIrrevocableTrust EntityKind = "IRREVOCABLE_TRUST"

const EntityKindSlatTrust EntityKind = "SLAT_TRUST"

const EntityKindIlitTrust EntityKind = "ILIT_TRUST"

const EntityKindQprtTrust EntityKind = "QPRT_TRUST"

const EntityKindGratTrust EntityKind = "GRAT_TRUST"

const EntityKindCrtTrust EntityKind = "CRT_TRUST"

const EntityKindCltTrust EntityKind = "CLT_TRUST"

const EntityKindIndividualPersonalAccount EntityKind = "INDIVIDUAL_PERSONAL_ACCOUNT"

const EntityKindJointPersonalAccount EntityKind = "JOINT_PERSONAL_ACCOUNT"

const EntityKindCustodialPersonalAccount EntityKind = "CUSTODIAL_PERSONAL_ACCOUNT"

const EntityKindInsurancePersonalAccount EntityKind = "INSURANCE_PERSONAL_ACCOUNT"

const EntityKindQualifiedTuitionPersonalAccount EntityKind = "QUALIFIED_TUITION_PERSONAL_ACCOUNT"

const EntityKindRetirementPersonalAccount EntityKind = "RETIREMENT_PERSONAL_ACCOUNT"

const EntityKindDonorAdvisedFund EntityKind = "DONOR_ADVISED_FUND"

const EntityKindPrivateFoundation EntityKind = "PRIVATE_FOUNDATION"

const EntityKindLlcBusinessEntity EntityKind = "LLC_BUSINESS_ENTITY"

const EntityKindLpBusinessEntity EntityKind = "LP_BUSINESS_ENTITY"

const EntityKindGpBusinessEntity EntityKind = "GP_BUSINESS_ENTITY"

const EntityKindSoleProprietorshipBusinessEntity EntityKind = "SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"

const EntityKindScorpBusinessEntity EntityKind = "SCORP_BUSINESS_ENTITY"

const EntityKindCcorpBusinessEntity EntityKind = "CCORP_BUSINESS_ENTITY"

Stage EntityStage

Lifecycle stage of the entity

One of the following:

const EntityStagePreCreated EntityStage = "PRE_CREATED"

const EntityStageAICreating EntityStage = "AI_CREATING"

const EntityStageAICreationFailed EntityStage = "AI_CREATION_FAILED"

const EntityStageAINeedsReview EntityStage = "AI_NEEDS_REVIEW"

const EntityStageDraft EntityStage = "DRAFT"

const EntityStageReadyForProposal EntityStage = "READY_FOR_PROPOSAL"

const EntityStageImplementation EntityStage = "IMPLEMENTATION"

const EntityStageActive EntityStage = "ACTIVE"

const EntityStageCompleted EntityStage = "COMPLETED"

const EntityStageArchived EntityStage = "ARCHIVED"

UpdatedAt Time

Timestamp when the entity was last updated

formatdate-time

ExternalID stringOptional

Customer-supplied identifier from an external system. Unique within the caller’s tenant when set.

minLength1

PageInfo PageInfo

HasNextPage bool

When paginating forwards, are there more items?

HasPreviousPage bool

When paginating backwards, are there more items?

EndCursor stringOptional

Cursor pointing to the last item in the current page

StartCursor stringOptional

Cursor pointing to the first item in the current page

TotalCount int64

Total number of items matching the query (across all pages)

EntitiesValuation

Get the current valuation for an entity

client.Entities.Valuation.Get(ctx, id) (*Valuation, error)

GET/entities/{id}/valuation

Create a new valuation for an entity

client.Entities.Valuation.New(ctx, id, body) (*Valuation, error)

POST/entities/{id}/valuation

ModelsExpand Collapse

type Valuation struct{…}

ID string

Unique identifier with valuationv2_ prefix

CreatedAt Time

Timestamp when the valuation was created

formatdate-time

DirectlyHeldAssetValue float64

Total value of all directly held assets in USD

formatdouble

DirectlyHeldAssets []ValuationDirectlyHeldAsset

List of individual assets in this valuation

ID string

Asset ID

AssetClass ValuationDirectlyHeldAssetAssetClass

ID string

Asset class ID

DisplayName string

Display name of the asset class

DisplayName string

Display name of the asset

Value float64

Value of this asset in USD

formatdouble

ExternalID stringOptional

External ID from the static asset (if available)

EffectiveDate Time

The date this valuation is effective

formatdate

EntityID string

Entity ID this valuation belongs to

TotalValue float64

Total value of all assets minus liabilities in USD

formatdouble

UpdatedAt Time

Timestamp when the valuation was last updated

formatdate-time

Description stringOptional

Free-form notes about this valuation

maxLength2048