Skip to main content

AddBeneficiaryInput

No description

input AddBeneficiaryInput {
  address: PhysicalAddressInput
  allocation: Int!
  beneficiaryPriority: BeneficiaryPriority!
  beneficiaryType: BeneficiaryType!
  dateOfBirth: DateString
  email: EmailAddress
  idempotencyKey: String
  personName: BeneficiaryPersonNameInput
  personRelationship: PersonRelationship
  phoneNumber: PhoneNumberStrict
  remainingAllocations: [BeneficiaryAllocation!]!
  tin: String
  trustFormationDate: DateString
  trustName: String
}

Fields​

AddBeneficiaryInput.address ● PhysicalAddressInput input​

Address of beneficiary

AddBeneficiaryInput.allocation ● Int! non-null scalar​

Allocation percentage THIS beneficiary will receive upon disbursement

AddBeneficiaryInput.beneficiaryPriority ● BeneficiaryPriority! non-null enum​

Indicates whether the beneficiary is primary or contingent

AddBeneficiaryInput.beneficiaryType ● BeneficiaryType! non-null enum​

Type of beneficiary, e.g. Person, Trust, Estate...

AddBeneficiaryInput.dateOfBirth ● DateString scalar​

Date of birth of beneficiary if the beneficiary is a person

AddBeneficiaryInput.email ● EmailAddress scalar​

The email address of the beneficiary

AddBeneficiaryInput.idempotencyKey ● String scalar​

Optional idempotency key to prevent the creation of the same beneficiary multiple times. Key may be comprised of alphanumeric values, as well as the following symbols: '_', '-', '.'

AddBeneficiaryInput.personName ● BeneficiaryPersonNameInput input​

Name of beneficiary if the beneficiary is a person

AddBeneficiaryInput.personRelationship ● PersonRelationship enum​

Relationship of beneficiary if the beneficiary is a person

AddBeneficiaryInput.phoneNumber ● PhoneNumberStrict scalar​

Phone number of beneficiary

AddBeneficiaryInput.remainingAllocations ● [BeneficiaryAllocation!]! non-null input​

The allocations to spread amongst the OTHER beneficiaries after this beneficiary is added. The percentages here, PLUS the value of the allocation field, must equal 100. Note that even if they equal 100 here, these will still be validated against the state of the DB across all allocations for this account, of this same beneficiaryPriority

AddBeneficiaryInput.tin ● String scalar​

Tax identification number of the beneficiary

AddBeneficiaryInput.trustFormationDate ● DateString scalar​

Formation date of trust if the beneficiary is a trust

AddBeneficiaryInput.trustName ● String scalar​

Name of trust if the beneficiary is a trust

Member of​

addBeneficiary mutation