Cmdlets for Vault CRM

Build 25.0.9434

SampleLimitTransactions

Logs all events related to sample limit consumption or updates, including adjustments, usage, and resets. This enables auditing of sample distribution against preset limits and supports compliance monitoring.

Columns

Name Type ReadOnly Description
ID [KEY] String True

Unique identifier for the sample limit transaction record.

Global ID String True

System-generated global identifier used to ensure uniqueness across all Vault instances.

Link String False

System-generated URL link that provides direct access to the sample limit transaction record.

Sample Limit Transaction Name String True

Descriptive name of the sample limit transaction, typically used for display and reference.

Status String False

Current status of the transaction, such as Draft, Submitted, or Approved, reflecting its lifecycle stage.

Created By String True

Username or ID of the user who initially created the transaction record.

Created Date Datetime True

Timestamp indicating when the transaction record was first created.

Last Modified By String True

Username or ID of the user who last modified the transaction record.

Last Modified Date Datetime True

Timestamp indicating when the transaction record was most recently updated.

Account Id String False

Unique identifier of the associated account, typically referring to the healthcare professional or organization.

Account Name String False

Name of the account (healthcare provider or organization) associated with the sample limit transaction.

Amount To Disburse Decimal False

Planned monetary amount of sample product to be disbursed during the transaction, in the local currency.

Amount To Disburse Corp Decimal True

Equivalent corporate value of the amount to disburse, normalized for cross-region analysis and reporting.

Local Currency String False

Three-letter ISO currency code (such as USD, EUR) representing the local currency of the transaction.

Call Id String False

Unique identifier of the related call activity that initiated the sample transaction.

Call Sample Id String False

Unique identifier for the sample product provided during the call activity linked to this transaction.

Call Name String False

Descriptive name or title of the call associated with this sample limit transaction.

Disbursed Amount Decimal False

Actual monetary amount that was disbursed as part of this transaction, recorded in local currency.

Disbursed Amount Corp Decimal True

Equivalent corporate value of the disbursed amount, used for consolidated financial tracking.

Disbursed Quantity Decimal False

Total quantity of the sample products disbursed in this transaction.

End Date Date False

The effective end date of the transaction, indicating the last day it is valid or enforceable.

Enforce Limit Bool False

Indicates whether the sample disbursement is subject to predefined enforcement limits (true or false).

External Id String False

Reference ID from an external system used to integrate or track the transaction outside of Vault.

Group Id String False

Identifier representing a group or batch of transactions, often used for bulk processing or grouping related activities.

Limit Amount Decimal False

Total monetary value of the allowed sample limit for the specific transaction, expressed in the local currency.

Limit Amount Corp Decimal True

Corporate-level monetary limit for the sample transaction, typically reflecting enterprise-wide restrictions.

Limit Per Call Bool False

Indicates whether the sample limit applies to each call individually (true) or across multiple calls (false).

Limit Quantity Decimal False

Maximum number of sample units permitted to be distributed under this transaction.

Lot Number String False

Unique identifier for the product lot being disbursed, used for traceability and inventory management.

Merged Bool False

Specifies whether this transaction has been merged with another record, indicating consolidation of sample limits.

Product Id String False

Internal identifier of the product being sampled, typically used for data integration and system reference.

Product Name String False

Name of the product being sampled in this transaction, as recorded in the system.

Quantity To Disburse Decimal False

Planned number of sample units to be distributed during the call or transaction.

Reason String False

Justification or rationale for disbursing a sample, such as medical need or product launch.

Remaining Amount Decimal False

Remaining monetary value allowed to be disbursed under this sample limit after prior transactions.

Remaining Amount Corp Decimal True

Remaining corporate-level monetary value available for disbursement under this sample program.

Remaining Quantity Decimal False

Remaining number of sample units that can still be disbursed under the current limit.

Sample Limit Id String False

Unique identifier of the sample limit record associated with this transaction.

Sample Limit Name String False

Display name or label for the sample limit configuration used in this transaction.

Sample Limit Type String False

Categorization of the sample limit, such as annual, per-call, or product-specific.

Start Date Date False

Effective start date of the sample limit, indicating when the limit begins to apply.

User Id String False

Internal identifier of the user (typically a field representative) performing the sample transaction.

User Name String False

Full name of the user responsible for executing the sample transaction.

Account String False

Target account associated with the sample disbursement, typically representing a healthcare professional or organization.

Call String False

Identifier of the call record linked to this sample transaction, capturing interaction context.

Product String False

Reference to the product entity related to the sample transaction for traceability.

Sample Limit String False

Reference field linking to the overall sample limit configuration that governs this transaction.

User String False

Reference to the user entity associated with this sample limit transaction.

Owner String False

Identifier of the owner of the record, typically the user who created or is responsible for the transaction.

Legacy CRM Id String False

Identifier from a previous Customer Relationship Management (CRM) system used for data migration or backward compatibility.

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