Skip to main content

UpdateBeneficiaryInput

No description

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

Fields​

UpdateBeneficiaryInput.address ● PhysicalAddressInput input​

UpdateBeneficiaryInput.allocation ● Int! non-null scalar​

UpdateBeneficiaryInput.beneficiaryId ● ID! non-null scalar​

UpdateBeneficiaryInput.beneficiaryPriority ● BeneficiaryPriority enum​

UpdateBeneficiaryInput.beneficiaryType ● BeneficiaryType enum​

UpdateBeneficiaryInput.dateOfBirth ● DateString scalar​

UpdateBeneficiaryInput.email ● EmailAddress scalar​

UpdateBeneficiaryInput.personName ● BeneficiaryPersonNameInput input​

UpdateBeneficiaryInput.personRelationship ● PersonRelationship enum​

UpdateBeneficiaryInput.phoneNumber ● PhoneNumberStrict scalar​

UpdateBeneficiaryInput.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

UpdateBeneficiaryInput.tin ● String scalar​

UpdateBeneficiaryInput.trustFormationDate ● DateString scalar​

UpdateBeneficiaryInput.trustName ● String scalar​

Member of​

updateBeneficiary mutation