PUT

/BizEntity

When to Use

Update entity details, status, or classification
Modify party relationships or authorized signatories
Update tax residency or investor status information
Refresh addresses, contact details, or payment methods

Prerequisites

Entity must exist in the system (provide bizEntityID or externalBizEntityId)

Considerations

All nested arrays (accounts, addresses, parties, communications, paymentDetails) are completely replaced - include ALL items you want to keep
bizEntityTypeID cannot be changed after creation
accounts and bizEntityParties arrays are required (cannot be empty)
All accounts must share the same productID (Same ProductID Rule)
Changing bizEntityStatusID to Inactive or Suspended prevents transaction processing

Description

Updates an existing entity by completely replacing its data. All nested arrays (accounts, addresses, parties, communications, paymentDetails) are replaced entirely, not merged with existing data.

Data Loss Risk: Nested arrays are replaced completely. For example, sending 2 accounts when 5 exist deletes the other 3 permanently. Omitting an array deletes all items in that array.

Safe Update Process: Always GET the current entity first, modify the specific fields you need to change, then PUT the complete structure back including all unchanged nested arrays.

Person Reuse & Deduplication

When updating entities with person structures, use externalPersonId consistently across nested objects to maintain unified person identity and prevent duplicate person records. This applies to both direct party relationships and organisation associated persons.

📚 Comprehensive Documentation

For detailed deduplication patterns, validation rules, and worked examples:

Complete Deduplication Guide - Technical reference with validation logic and advanced scenarios
POST Endpoint Patterns - Practical worked examples showing dual-role and multi-context person reuse

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier
Content-Type	application/json	Content type for request body

Request Body

Parameter	Type	Required	Description
`BizEntityID` >	integer	> Required...	Identifies which entity to update. Must match existing entity in system.
`externalBizEntityId` >	string	> Conditional...	Updates your external system identifier for dual-ID integration. Changes may break external system linkages depending on API integration stability.
`bizEntityTypeID` >	integer	> Required...	Entity type classification (Individual=1, Company=2, Trust=3, SMSF=4, Partnership=5). Must match entity's current type - type changes not permitted in updates.
`advisorNumber`	string	Optional	Updates advisor identifier. Changes affect commission routing and reporting permissions.
`authorizedNomineePersonID` >	integer	> Conditional...	Updates authorized nominee PersonID for trust structures. Referenced person must exist with verified authorization levels.
`bizEntityStatusID` >	integer	> Required...	Updates operational status. Use GET /Common/Lookup?Name=bizEntityStatusID for valid status values. Status changes trigger automatic workflows and affect transaction processing capabilities.
`bizEntityTaxOfficeTypeID` >	integer	> Conditional...	Updates tax office jurisdiction type affecting reporting format. Changes trigger FATCA/CRS recalculation and compliance workflow updates.
`communicationPreferenceCopyParentBizEntity`	boolean	Optional	Updates inheritance setting for communication preferences from parent entity.
`communicationPreferenceID`	integer	Optional	Updates communication preference identifier. Only applies when not inheriting from parent entity.
`contactPerson`	string	Optional	Updates primary contact person name for administrative communications.
`controllingPID` >	integer	> Conditional...	Updates controlling PersonID for beneficial ownership tracking. Used for FATCA/CRS reporting and AML compliance.
`corporateRepresentative`	string	Optional	Updates corporate representative name for company entities.
`customerCategoryID`	integer	Optional	Updates customer category affecting fee structures and service levels.
`customerCode`	string	Optional	Updates internal customer reference code for system integration.
`description`	string	Optional	Updates entity description or operational notes (max 2000 chars).
`groupedWithBizEntityID` >	integer	> Conditional...	Updates parent entity ID for group structures. Changes consolidated reporting and inheritance settings.
`investorTypeID`	integer	Optional	Updates investor type classification affecting product eligibility.
`isDirectorInterest`	boolean	Optional	Updates director interest flag for listed securities disclosure.
`isExecutiveInterest`	boolean	Optional	Updates executive/insider interest flag for transaction reporting.
`legalName`	string	Optional	Updates official registered legal name. Must match current incorporation documents.
`marginLenderOrganisationID` >	integer	> Conditional...	Updates margin lending organisation ID for facility arrangements. Affects transaction limits and risk management.
`name`	string	Optional	Updates display name for reports and interfaces. Can differ from legal name.
`powerOfAttorney`	string	Optional	Updates power of attorney details documenting current arrangements.
`purposeOfInvestmentID`	integer	Optional	Updates investment purpose classification affecting suitability assessments.
`salesPersonID`	integer	Optional	Updates sales person or relationship manager. Changes commission allocation.
`salutation`	string	Optional	Updates preferred salutation for correspondence.
`signatureParty` >	integer	> Conditional...	Updates authorized signatory PersonID for transaction approval. New signatory must complete identity verification.
`sophisticatedInvestorCertificateDate` >	string (date)	> Conditional...	Updates sophisticated investor certification date for wholesale product access. Date must be current (typically <2 years).
`sophisticatedInvestorComment`	string	Optional	Updates notes regarding sophisticated investor qualification basis.
`sophisticatedInvestorEligibility`	string	Optional	Updates basis for sophisticated investor status (accountant certificate, income test, assets test).
`sourceOfFundsID`	integer	Optional	Updates source of funds classification for AML/CTF compliance.
`specialConditions`	string	Optional	Updates special terms or operational conditions (max 2000 chars).
`standingProxy`	string	Optional	Updates standing proxy arrangements for voting rights.
`taxationCountryCode`	string	Optional	Updates primary tax jurisdiction (ISO code). Used for FATCA/CRS reporting.
`createdDate`	datetime	Optional	System-assigned creation timestamp. Read-only field - cannot be modified in updates. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
`accounts`	> List<AccountDTO>...	Optional	Complete list of investment accounts for this entity. PUT operations replace entire array - include every account to keep (modified and unmodified). Omitted accounts are permanently deleted with transaction history. Same ProductID rule applies across all accounts.
`addresses`	> List<AddressDTO>...	Optional	Complete list of addresses for this entity. PUT operations replace entire array - include every address to keep (changed and unchanged). Omitted addresses are permanently deleted, affecting compliance records (AML/KYC verification), correspondence delivery, and regulatory reporting (CRS/FATCA).
`communications`	> List<CommunicationDTO>...	Optional	Complete list of contact methods for this entity. PUT operations replace entire array - include every contact method to keep. Omitted communications are permanently deleted, breaking correspondence routing (distribution notifications, regulatory notices, statement delivery).
`paymentDetails`	> List<PaymentDetailDTO>...	Optional	Complete list of payment instructions for this entity. PUT operations replace entire array - include every payment method to keep. Omitted payment details are permanently deleted, breaking automated distribution processing, redemption payments, and deposit routing.
`bizEntityParties`	> List<BizEntityPartyDTO>...	Optional	Complete list of party relationships for this entity. PUT operations replace entire array - include every party (persons and organisations) to keep. Omitted parties are permanently deleted, removing their roles (primary contact, signatory, income recipient, authorized nominee) and breaking entity authorization structures.
`bizEntityParents`	> List<BizEntityParentDTO>...	Optional	Complete list of parent relationships for this entity. PUT operations replace entire array - include every parent relationship to keep. Omitted relationships are permanently deleted, breaking parent-child hierarchies and dealer group affiliations.

BizEntityID

integer

> Required...

Identifies which entity to update. Must match existing entity in system.

externalBizEntityId

string

> Conditional...

Updates your external system identifier for dual-ID integration. Changes may break external system linkages depending on API integration stability.

bizEntityTypeID

integer

> Required...

Entity type classification (Individual=1, Company=2, Trust=3, SMSF=4, Partnership=5). Must match entity's current type - type changes not permitted in updates.

advisorNumber

string

Optional

Updates advisor identifier. Changes affect commission routing and reporting permissions.

authorizedNomineePersonID

integer

> Conditional...

Updates authorized nominee PersonID for trust structures. Referenced person must exist with verified authorization levels.

bizEntityStatusID

integer

> Required...

Updates operational status. Use GET /Common/Lookup?Name=bizEntityStatusID for valid status values. Status changes trigger automatic workflows and affect transaction processing capabilities.

bizEntityTaxOfficeTypeID

integer

> Conditional...

Updates tax office jurisdiction type affecting reporting format. Changes trigger FATCA/CRS recalculation and compliance workflow updates.

communicationPreferenceCopyParentBizEntity

boolean

Optional

Updates inheritance setting for communication preferences from parent entity.

communicationPreferenceID

integer

Optional

Updates communication preference identifier. Only applies when not inheriting from parent entity.

contactPerson

string

Optional

Updates primary contact person name for administrative communications.

controllingPID

integer

> Conditional...

Updates controlling PersonID for beneficial ownership tracking. Used for FATCA/CRS reporting and AML compliance.

corporateRepresentative

string

Optional

Updates corporate representative name for company entities.

customerCategoryID

integer

Optional

Updates customer category affecting fee structures and service levels.

customerCode

string

Optional

Updates internal customer reference code for system integration.

description

string

Optional

Updates entity description or operational notes (max 2000 chars).

groupedWithBizEntityID

integer

> Conditional...

Updates parent entity ID for group structures. Changes consolidated reporting and inheritance settings.

investorTypeID

integer

Optional

Updates investor type classification affecting product eligibility.

isDirectorInterest

boolean

Optional

Updates director interest flag for listed securities disclosure.

isExecutiveInterest

boolean

Optional

Updates executive/insider interest flag for transaction reporting.

legalName

string

Optional

Updates official registered legal name. Must match current incorporation documents.

marginLenderOrganisationID

integer

> Conditional...

Updates margin lending organisation ID for facility arrangements. Affects transaction limits and risk management.

name

string

Optional

Updates display name for reports and interfaces. Can differ from legal name.

powerOfAttorney

string

Optional

Updates power of attorney details documenting current arrangements.

purposeOfInvestmentID

integer

Optional

Updates investment purpose classification affecting suitability assessments.

salesPersonID

integer

Optional

Updates sales person or relationship manager. Changes commission allocation.

salutation

string

Optional

Updates preferred salutation for correspondence.

signatureParty

integer

> Conditional...

Updates authorized signatory PersonID for transaction approval. New signatory must complete identity verification.

sophisticatedInvestorCertificateDate

string (date)

> Conditional...

Updates sophisticated investor certification date for wholesale product access. Date must be current (typically <2 years).

sophisticatedInvestorComment

string

Optional

Updates notes regarding sophisticated investor qualification basis.

sophisticatedInvestorEligibility

string

Optional

Updates basis for sophisticated investor status (accountant certificate, income test, assets test).

sourceOfFundsID

integer

Optional

Updates source of funds classification for AML/CTF compliance.

specialConditions

string

Optional

Updates special terms or operational conditions (max 2000 chars).

standingProxy

string

Optional

Updates standing proxy arrangements for voting rights.

taxationCountryCode

string

Optional

Updates primary tax jurisdiction (ISO code). Used for FATCA/CRS reporting.

createdDate

datetime

Optional

System-assigned creation timestamp. Read-only field - cannot be modified in updates. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).

accounts

> List<AccountDTO>...

Optional

Complete list of investment accounts for this entity. PUT operations replace entire array - include every account to keep (modified and unmodified). Omitted accounts are permanently deleted with transaction history. Same ProductID rule applies across all accounts.

addresses

> List<AddressDTO>...

Optional

Complete list of addresses for this entity. PUT operations replace entire array - include every address to keep (changed and unchanged). Omitted addresses are permanently deleted, affecting compliance records (AML/KYC verification), correspondence delivery, and regulatory reporting (CRS/FATCA).

communications

> List<CommunicationDTO>...

Optional

Complete list of contact methods for this entity. PUT operations replace entire array - include every contact method to keep. Omitted communications are permanently deleted, breaking correspondence routing (distribution notifications, regulatory notices, statement delivery).

paymentDetails

> List<PaymentDetailDTO>...

Optional

Complete list of payment instructions for this entity. PUT operations replace entire array - include every payment method to keep. Omitted payment details are permanently deleted, breaking automated distribution processing, redemption payments, and deposit routing.

bizEntityParties

> List<BizEntityPartyDTO>...

Optional

Complete list of party relationships for this entity. PUT operations replace entire array - include every party (persons and organisations) to keep. Omitted parties are permanently deleted, removing their roles (primary contact, signatory, income recipient, authorized nominee) and breaking entity authorization structures.

bizEntityParents

> List<BizEntityParentDTO>...

Optional

Complete list of parent relationships for this entity. PUT operations replace entire array - include every parent relationship to keep. Omitted relationships are permanently deleted, breaking parent-child hierarchies and dealer group affiliations.

Example Requests

bash

curl -X PUT 'https://api.7g.com.au/BizEntity' \
  -H 'Version: 2.0' \
  -H 'Authorization: {accessToken}' \
  -H 'Content-Type: application/json' \
  -d '{
    "bizEntityID": 12345,
    "bizEntityTypeID": 4,
    "name": "John Smith Investment Trust - Updated",
    "bizEntityStatusID": 1,
    "communicationPreferenceCopyParentBizEntity": false,
    "isDirectorInterest": false,
    "isExecutiveInterest": false,
    "externalBizEntityId": "ENT-001",
    "advisorNumber": "ADV-12345",
    "legalName": "John Smith Investment Trust",
    "description": "Updated trust structure with new beneficiaries",
    "customerCode": "CUST-001",
    "taxationCountryCode": "AUS",
    "sophisticatedInvestorCertificateDate": "2024-03-15",
    "sophisticatedInvestorEligibility": "Accountant Certificate",
    "accounts": [
      {
        "accountID": 987,
        "productID": 1,
        "accountNumber": "ACC-001",
        "currencyID": 1,
        "drpTypeID": 2,
        "drpValue": 100.00,
        "accountStatusID": 1,
        "balance": 250000.00
      }
    ],
    "addresses": [
      {
        "addressID": 321,
        "addressTypeID": 101,
        "addressLine": "456 Updated Street",
        "suburb": "Sydney",
        "postcode": "2000",
        "stateCode": "NSW",
        "countryCode": "AUS"
      }
    ],
    "communications": [
      {
        "communicationID": 654,
        "communicationTypeID": 1,
        "name": "john.smith.updated@email.com"
      },
      {
        "communicationID": 655,
        "communicationTypeID": 2,
        "name": "+61412345678"
      }
    ],
    "paymentDetails": [
      {
        "paymentDetailID": 111,
        "paymentTypeID": 1,
        "bsb": "062000",
        "accountNumber": "12345678",
        "accountName": "John Smith Trust Account",
        "isForDistribution": true,
        "isForRedemption": true,
        "isForDeposit": false,
        "isForOther": false
      }
    ],
    "bizEntityParties": [
      {
        "bizEntityPartyID": 789,
        "personID": 456,
        "isPrimaryContact": true,
        "isIncomeReceiving": true,
        "isSignatory": true,
        "isAuthorisedNominee": false,
        "isPowerOfAttorney": false,
        "ordinal": 1
      }
    ],
    "bizEntityParents": [
      {
        "parentBizEntityID": 10001,
        "activeFrom": "2024-01-01"
      }
    ]
  }'

Response Examples

json

{
  "result": true,
  "message": "Entity updated successfully",
  "recordCount": 1,
  "data": [
    {
      "bizEntityID": 12345,
      "externalBizEntityId": "ENT-001",
      "bizEntityTypeID": 4,
      "name": "John Smith Investment Trust - Updated",
      "bizEntityStatusID": 1,
      "legalName": "John Smith Investment Trust",
      "description": "Updated trust structure with new beneficiaries",
      "customerCode": "CUST-001",
      "taxationCountryCode": "AUS",
      "createdDate": "2024-01-15T08:30:00Z",
      "sophisticatedInvestorCertificateDate": "2024-03-15",
      "sophisticatedInvestorEligibility": "Accountant Certificate",
      "accounts": [
        {
          "accountID": 987,
          "productID": 1,
          "accountNumber": "ACC-001",
          "currencyID": 1,
          "drpTypeID": 2,
          "drpValue": 100.00,
          "accountStatusID": 1,
          "balance": 250000.00
        }
      ],
      "addresses": [
        {
          "addressID": 321,
          "addressTypeID": 101,
          "addressLine": "456 Updated Street",
          "suburb": "Sydney",
          "postcode": "2000",
          "stateCode": "NSW",
          "countryCode": "AUS"
        }
      ],
      "communications": [
        {
          "communicationID": 654,
          "communicationTypeID": 1,
          "name": "john.smith.updated@email.com"
        },
        {
          "communicationID": 655,
          "communicationTypeID": 2,
          "name": "+61412345678"
        }
      ],
      "paymentDetails": [
        {
          "paymentDetailID": 111,
          "paymentTypeID": 1,
          "bsb": "062000",
          "accountNumber": "12345678",
          "accountName": "John Smith Trust Account",
          "isForDistribution": true,
          "isForRedemption": true
        }
      ],
      "bizEntityParties": [
        {
          "bizEntityPartyID": 789,
          "personID": 456,
          "isPrimaryContact": true,
          "isIncomeReceiving": true,
          "isSignatory": true,
          "ordinal": 1
        }
      ],
      "bizEntityParents": [
        {
          "bizEntityID": 12345,
          "externalBizEntityId": "ENT-001",
          "parentBizEntityID": 10001,
          "parentExternalBizEntityId": "PARENT-001",
          "activeFrom": "2024-01-01",
          "activeTo": null
        }
      ]
    }
  ]
}

When to Use

Prerequisites

Considerations

Description

Person Reuse & Deduplication

📚 Comprehensive Documentation

Required Headers - See Authentication

Request Body

Example Requests

Response Examples

Related Endpoints

Connection Lost