Cmdlets for Vault CRM

Build 25.0.9434

Addresses

Holds postal address information for entities such as accounts or HCPs, supporting mailing, territory assignment, and location-based services.

Columns

Name Type ReadOnly Description
ID [KEY] String True

Unique identifier for the address record, used as the primary key within the table.

Address Type String True

Specifies the type of address (for example, office, home, billing) as defined by the object_type__v classification in Veeva Vault.

Global ID String True

System-generated globally unique identifier (GUID) for the address, used to ensure consistent referencing across Vault environments.

Link String False

Internal system link reference that points to the full object or record associated with the address.

Address line 1 String False

Primary line of the street address, usually containing street name and number as stored in name__v.

Status String False

Current lifecycle status of the address record (for example, Active, Inactive), based on status__v field in Vault.

Created By String True

Username or system identifier of the user who created the address record in Vault, from created_by__v.

Created Date Datetime True

Timestamp representing when the address record was initially created, formatted as a datetime value from created_date__v.

Last Modified By String True

Username or system identifier of the last user who updated the record, pulled from modified_by__v.

Last Modified Date Datetime True

Timestamp of the most recent update to the address record, derived from modified_date__v.

ASSMCA String False

Puerto Rico-specific regulatory field indicating the address's association with ASSMCA (Administración de Servicios de Salud Mental y Contra la Adicción), if applicable.

Street Address 2 String False

Secondary address line for additional location details such as suite, floor, or apartment number, taken from street_address_2_cda__v.

Appt. Required Bool False

Boolean value indicating whether an appointment is required to visit this address location, based on appt_required__v.

Billing Bool False

Boolean flag indicating whether this address is designated as a billing address in the system (billing_cda__v = true).

Brick String False

Sales or geographic brick identifier used for territory alignment or marketing segmentation, which is derived from brick__v.

Business Bool False

Boolean indicator identifying if this address is a place of business (true) or not (false), as defined by business_cda__v.

CDS Expiration Date Date False

Date on which the Controlled Dangerous Substances (CDS) license associated with this address expires, stored in cds_expiration_date__v.

CDS Status String False

Current status of the CDS registration associated with this address, such as Active, Expired, or Pending Renewal, based on cds_status__v.

CDS # String False

Unique identifier assigned to the address within the Customer Data Source (CDS) system. This is used for cross-referencing address records with external data feeds.

City String False

The city portion of the physical address, used for geographic categorization and reporting.

Clear GPS Coordinates Bool False

Indicates whether the existing GPS latitude and longitude values should be cleared or reset during data updates.

Comment String False

Optional free-text field that allows users to add additional notes or context related to the address.

Controlled Address Bool False

Specifies whether the address is classified as 'controlled' within regulatory or compliance workflows. This can affect downstream processing or visibility.

Customer Master Status String False

Represents the current integration or validation status of the address within the centralized customer master system.

DEA Address? Bool False

Boolean flag indicating whether this address is approved for use on Drug Enforcement Administration (DEA) licenses or registrations.

DEA Expiration Date Date False

The expiration date of the DEA registration associated with this address, used for compliance and validation.

DEA License Address String False

The physical address associated with the DEA license. Often used as the primary address for regulatory communication.

DEA Schedule String False

Specifies the DEA drug schedules (for example, Schedule II, III, IV) that apply to this address, based on the DEA registration. Values are typically separated by commas: Schedule II, Schedule III, Schedule IV.

DEA Status String False

Current regulatory status of the DEA license associated with this address, such as Active, Expired, or Suspended.

DEA # String False

The DEA registration number linked to this address. Required for activities involving controlled substances.

Entity Reference Id String False

An internal reference ID used to link this address to its parent entity or related data structures within the Vault.

External ID String False

Identifier used to link the address record to external systems or third-party data sources. This can be a Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP) system key.

Fax 2 String False

Secondary fax number for the address, used as an alternative contact method if the primary fax is unavailable.

Fax String False

Primary fax number associated with the address. This is useful for formal document transmissions.

Home Bool False

Indicates whether this address is designated as a home or residential address, as opposed to a business or institutional address.

Inactive Bool False

Indicates whether the address is currently marked as inactive and should be excluded from standard operations or assignments.

Include in Territory Assignment Bool False

Flag indicating whether this address should be considered during territory alignment and assignment processes.

Latitude Double False

The latitude coordinate of the address location, used in mapping, distance calculations, and territory modeling.

License Expiration Date Date False

The expiration date of the professional license associated with this address. Critical for validating healthcare provider status.

License Status String False

Current status of the professional license tied to this address. Values can include Active, Expired, or Pending Verification.

License # String False

Unique identifier for the professional license associated with the address, typically assigned by a regulatory or licensing authority.

Lock Bool False

Indicates whether the address record is locked from further edits. A locked record cannot be modified until the lock is removed.

Longitude Double False

The longitudinal geographic coordinate for the address location, used in mapping and spatial analysis.

Mailing Bool False

Specifies whether this address should be used for receiving mailed correspondence. This is useful for distinguishing between mailing and physical addresses.

Master Align Id String False

Identifier used for alignment with master data records. Helps in associating this address with centrally governed address references.

Mobile ID String False

Unique identifier used for synchronization between Vault and mobile applications. Enables mobile-specific data tracking.

Network ASSMCA Entity ID String False

Identifier issued by ASSMCA (Puerto Rico's Mental Health and Addiction Services Administration) representing a healthcare entity in the Network data model.

Network CDS Entity ID String False

Identifier for the entity as recognized by the Controlled Dangerous Substances (CDS) registry within the Network system.

Network Collaborative Agreement Required String False

Indicates whether a collaborative agreement is required for the healthcare provider at this address to perform certain clinical or prescriptive activities.

Network Comp Prescriptive Authority String False

Details the authority granted to a provider at this address to prescribe compounded medications, based on Network regulations.

Network Comp Sample Eligibility String False

Specifies whether the provider at this address is eligible to receive samples of compounded medications, according to Network rules.

Network Ctrl Sub Prescriptive Authority String False

Indicates whether the provider has authority to prescribe controlled substances at this address, as recognized by Network compliance rules.

Network Ctrl Sub Sample Eligibility String False

Specifies whether the provider is permitted to receive samples of controlled substances at this address, based on Network eligibility.

Network DEA Entity ID String False

The Drug Enforcement Administration (DEA) entity ID associated with the provider at this location, used for controlled substance tracking and verification.

Network Distributor Entity ID String False

Identifier for the distributor organization associated with this address, as maintained in the Network entity registry.

Network License Entity ID String False

Represents the license entity ID within the Network platform that corresponds to the practitioner or organization at this address.

Network License Grace Expiry Date False

Date on which the grace period for the license at this address expires. After this date, the license can be considered inactive or invalid.

Network License Status Condition String False

Status condition of the license as defined by the Network system, indicating whether the license is active, expired, revoked, or suspended.

Network RXA Eligible String False

Indicates whether the provider at this address is eligible for RXA (e-prescription authorization) services under Network criteria.

Network Prescriptive Authority String False

Denotes the provider's eligibility to prescribe medication at this address, as governed by the Network's sample eligibility rules.

No Address Copy Bool False

Prevents this address from being copied into other related or downstream records, typically used to control data propagation.

Office Notes String False

Free-text field for entering internal notes or comments related to the office located at this address. Not typically exposed externally.

Phone 2 String False

Secondary phone number for the address, used when an alternative contact number is available or required.

Phone String False

Primary telephone number associated with the address, typically used for main office contact or verification.

Primary Bool False

Indicates whether this is the primary address for the associated entity. Only one address should be marked as primary.

Sample Send Status String False

Tracks the current status of sample shipments to this address, such as pending, sent, or failed.

Shipping Bool False

Specifies whether this address is eligible to receive shipments. This is useful for differentiating shipping locations from administrative addresses.

Source String False

Indicates the origin of the address record, such as manual entry, integration from an external CRM system, or synchronization with a third-party source.

Staff notes String False

Internal notes or annotations entered by staff regarding this address, typically used for context, instructions, or history related to the location.

State Distributor Category String False

Specifies the classification of the address as it relates to state distribution regulations, such as 'Retail', 'Wholesale', or 'Distributor'.

State Distributor Expiration Date Date False

The expiration date of the distributor's license as recognized by the specific state authority.

State Distributor License Exempt Bool False

Indicates whether the distributor is exempt from holding a license in the specified state (true = exempt, false = license required).

State Distributor Status String False

The current regulatory status of the distributor in the state, such as 'Active', 'Pending', or 'Suspended'.

State Distributor String False

The name or identifier of the distributor as recognized in state-level regulatory systems.

State String False

The U.S. state or Canadian province associated with the address. This can also apply to other international subdivisions where applicable.

Zip + 4 String False

The ZIP+4 postal code, used in the U.S. to provide more precise address routing. Format: 12345-6789.

Postal Code String False

The postal code associated with the address. Supports international formats, including Canadian and European postal systems.

Account String False

The account associated with this address, typically referencing a healthcare organization or business entity in Veeva Vault.

License Valid To Sample String True

The expiration date for the license related to sample distribution for this address. Format typically aligns with regional licensing authorities.

Sample Status String True

Indicates the current sample eligibility or compliance status for the address, such as 'Approved', 'Restricted', or 'Ineligible'.

Country String False

The country associated with the address. Stored in a standardized format for global compatibility.

Legacy CRM Id String False

An identifier carried over from a legacy customer relationship management system. This is used for backward compatibility and data mapping.

Map String True

May reference a map view, coordinates, or other geographic metadata associated with the address.

Veeva Network ID String False

A unique identifier assigned by Veeva Network, used for integration and record matching across systems.

Controlling Parent Account String False

The parent account that governs or oversees the current address or account, typically for hierarchical or compliance purposes.

Controlling Address String False

References the master or primary address from which this address inherits regulatory or organizational control.

Primary Address Reconcile Datetime True

Timestamp of the last reconciliation event used to determine whether this address should be treated as the primary location.

Sample Shipping Bool False

Indicates whether this address is enabled to receive shipments of sample products (true = enabled, false = disabled).

Status2 String False

A secondary or custom-defined status for the address, such as for segmentation, territory planning, or compliance.

Street Address 1 String True

The first line of the street address, typically containing the building number, street name, and unit or suite if applicable.

Best Times String False

Preferred times for making visits, deliveries, or contacts at this address. Stored as a string of time ranges or descriptors.

CDS Schedule String False

The scheduling identifier for CDS (Call, Detail, Sample) activities tied to this address, which can include frequency or day/time preferences.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434