BranchUnit

Represents details about a branch of an organization. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The ID of an account that contains additional information about a branch. The value must be unique within this organization.

BranchCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: An identifier that relates this branch to an external system.

BranchManagerId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of a user who is the manager or main point of contact for the branch unit.

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date the branch most recently stopped being active.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the branch is currently active and can be used for banker assignments and automatic associations.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date when a user referenced this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date when a user viewed this record.

LocationId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of a location where the branch does business.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description:

OperatingHoursId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of an operating hours record that specifies the hours when the branch is open for normal business operations.

OperationalState

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the operational readiness of a branch.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this record.

ParentBranchUnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of this branch’s parent branch unit, if it has one.

ServiceTerritoryId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of a service territory that corresponds to this branch unit.

StartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date the branch most recently became active.

Type

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the branch interaction type with customers.
Possible values:
- Physical—The branch only operates at a physical location
- PhysicalAndVirtual—Physical and Virtual
- Virtual—The branch only operates as a virtual entity

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

BranchUnitChangeEvent: Change events are available for the object.
BranchUnitFeed: Feed tracking is available for the object.
BranchUnitHistory: History is available for tracked fields of the object.
BranchUnitOwnerSharingRule: Sharing rules are available for the object.
BranchUnitShare: Sharing is available for the object.