Update beneficiary detail

Request

Updates the details of a specific beneficiary including personal information, contact details, and organisation details.

Security

Class_oAuth(Required scopes: fund.member.maintain)

Path

businessCodestringrequired

Class business code

Example:demo-business

fundCodestringrequired

Class entity code

Example:demo-fund

idanyrequired

A globally unique identifier (GUID) in standard UUID format to identify the beneficiary

Example:550e8400-e29b-41d4-a716-446655440000

Bodyapplication/jsonrequired

Statusstringrequired

The lifecycle status of the beneficiary within the fund. This value determines whether the beneficiary is active, suspended, or cancelled.

Enum:"Active""Suspended""Cancelled"

Example:"Active"

Numberstringrequired

The beneficiary’s unique number within the fund. This is used to identify the beneficiary for reporting and administration purposes.

Example:"1"

TaxFileNumberstring

The Australian Tax File Number (TFN) of the beneficiary. This field is optional and only applicable where a TFN is available and permitted to be stored.

Example:"123456789"

PartyTypestringrequired

Indicates whether the beneficiary is an individual person or an organisation. This value determines which detail object (PersonalDetails or OrganisationDetails) is required.

Enum:"Person""Organisation"

Example:"Person"

PersonalDetailsobject

Personal information about an individual beneficiary. This object is required when PartyType is set to Person.

OrganisationDetailsobject

Organisation information for a non-individual beneficiary. This object is required when PartyType is set to Organisation.

ContactDetailsobjectrequired

Contact and address information for the beneficiary. Address information is mandatory to ensure the beneficiary has a valid physical and mailing location recorded.

curl -i -X POST \
  https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/beneficiary-data/beneficiary-detail/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Status": "Active",
    "Number": "1",
    "TaxFileNumber": "123456789",
    "PartyType": "Person",
    "PersonalDetails": {
      "Title": "MR",
      "FirstName": "John",
      "MiddleNames": "William",
      "LastName": "Smith",
      "DateOfBirth": "1985-06-15",
      "Gender": "Male",
      "PreferredSalutation": "Mr",
      "PreferredName": "Johnny"
    },
    "OrganisationDetails": {
      "OrganisationName": "Acme Corporation Pty Ltd"
    },
    "ContactDetails": {
      "PreferredVoiceContact": "Mobile",
      "PreferredWrittenContact": "Email",
      "HomePhone": "61298765432",
      "WorkPhone": "61212345678",
      "Mobile": "61400123456",
      "Fax": "61299999999",
      "Direct": "61212345679",
      "Email": "john.smith@example.com",
      "UsePhysicalAddressForMailingAddress": true,
      "PhysicalAddress": {
        "Line1": "123 George Street",
        "Line2": "",
        "Line3": "",
        "Line4": "",
        "Suburb": "Sydney",
        "State": "NSW",
        "PostCode": "2000",
        "ValidateAddress": false,
        "Country": "AU"
      },
      "MailingAddress": {
        "Addressee": "John Smith",
        "Line1": "123 George Street",
        "Line2": "",
        "Line3": "",
        "Line4": "",
        "Suburb": "Sydney",
        "State": "NSW",
        "PostCode": "2000",
        "ValidateAddress": false,
        "Country": "AU"
      }
    }
  }'

Responses

Success (Ok)

Bodyapplication/json

ErrorCodesArray of stringsrequired

ErrorsArray of objectsrequired

CreatedUristringrequired

IsCreatedResponsebooleanrequired

Response

{
  "ErrorCodes": [
    "string"
  ],
  "Errors": [
    {
      "Code": "string",
      "Message": "string"
    }
  ],
  "CreatedUri": "string",
  "IsCreatedResponse": true
}