Quota Field Reference
The Quota object is an object that is used to allocate a fixed share of products to orders according to the conditions fulfilled.
-
Quotas are distributed per sales representatives.
-
Quotas can be applied based on the product quantity in the order or the amount of the delivery.
-
Quotas can be automatically created based on templates if the necessary conditions for applying the quota are met.
-
Quotas can be available for certain order types, product types, organizations, etc.
Object API name: orders__Quota__c
| Field | API Name | Type | Description | ||
|---|---|---|---|---|---|
Account |
orders__AccountId__c |
Lookup(Account) |
If specified, a quota is available for a certain Account. |
||
Active |
orders__IsActive__c |
Checkbox |
This field defines whether the quota is active or not. Only active quotas can be applied. |
||
Amount Field |
orders__AmountField__c |
Text(255) |
The API name of the field from the Delivery Line Item object that stores the final price for the order, for example, orders__TotalPrice__c. It is used when the orders__UnitOfMeasure__c field is Amount. The current user should have access to the specified field. |
||
Booked Amount |
orders__BookedAmount__c |
Currency(16,2) |
Amount of products in the delivery booked for the order. The default value is 0. It is used when the orders__UnitOfMeasure__c field is Amount and the orders__OrderStage__c field of the order is not Finalized or Completed. |
||
Booked Quantity |
orders__BookedQuantity__c |
Number(18,0) |
Quantity of products booked for the order. The default value is 0. It is used when the orders__UnitOfMeasure__c field is Quantity and the orders__OrderStage__c field of the order is not Finalized or Completed. |
||
Catalog |
orders__CatalogId__c |
Lookup(Catalog) |
If specified, a quota is available for a certain Catalog. The quota can be applied to either a catalog or a promo. If there are two identical quotas, the quota related to the promo will be given priority. |
||
End Date |
orders__EndDate__c |
Date |
It is a required field with the end date when the quota is available.
|
||
Ignore Bundle Components |
orders__IsIgnoreBundleComponents__c |
Checkbox |
If true, the quota is not available for bundle components. Default value is false. |
||
Limit Amount |
orders__LimitAmount__c |
Currency(16,2) |
Amount limit of products in the delivery that cannot be exceeded cumulatively on all orders in which the quota was used. It is used when the orders__UnitOfMeasure__c field is Amount. |
||
Limit Quantity |
orders__LimitQuantity__c |
Number(18,0) |
Quantity limit of products that cannot be exceeded cumulatively on all orders in which the quota was used. It is used when the orders__UnitOfMeasure__c field is Quantity. |
||
Order Type |
orders__OrderType__c |
Picklist (Multi-select) |
Select one or more order types to apply the quota. Available values:
|
||
Product |
ProductId__c |
Lookup(CT Product) |
This is a custom lookup to store a custom product identifier. Please create this field in case of using the custom CT Product or Pharma Product. If the product is a bundle, then the quota is applied to the whole bundle or separately to included products depending on the value in the Calculate Price On field. |
||
Product |
orders__Product2Id__c |
Lookup(Product2) |
This is a default lookup to the standard Product record in case of working with the CG Cloud solution. If the product is a bundle, then the quota is applied to the whole bundle or separately to included products depending on the value in the Calculate Price On field. |
||
Product Type |
orders__ProductType__c |
Picklist(Multi-select) |
It is a required field to select one or more product types to apply the quota to them. Available values:
|
||
Promotion |
orders__PromotiontId__c |
Lookup(Promotion) |
If specified, a quota is available for a certain Promotion. The quota can be applied to either a catalog or a promo. If there are two identical quotas, the quota related to the promo will be given priority. |
||
Quota Template |
orders__QuotaTemplatetId__c |
Lookup(Quota Template) |
The parent Quota record of the Template type (if exists). |
||
Record Type |
RecordTypeId |
Record Type |
The quota must be one of the following record types:
|
||
Retail Store |
RetailStore__c |
Lookup(Retail Store) |
If specified, a quota is available for a certain Retail Store. Create this field in case of working with the CG Cloud solution. |
||
Sales Organization |
orders__SalesOrganizationId__c |
Lookup(Sales Organization) |
It is a required field to relate a Quota record to a certain Sales Organization. |
||
Start Date |
orders__StartDate__c |
Date |
It is a required field with the start date when the quota is available.
|
||
Used Amount |
orders__UsedAmount__c |
Currency(16,2) |
The actual amount of products in the delivery used in the order. The default value is 0. It is used when the orders__UnitOfMeasure__c field is Amount and the orders__OrderStage__c field of the order is not On Hold. |
||
Used Quantity |
orders__UsedQuantity__c |
Number(18,0) |
The actual quantity of products used in the order. The default value is 0. It is used when the orders__UnitOfMeasure__c field is Quantity and the orders__OrderStage__c field of the order is not On Hold. |
||
User |
orders__UserId__c |
Lookup(User) |
If specified, the quota is available for the user. Each quota of the Individual record type must be assigned to the user. |
||
Unit of Measures |
orders__UnitOfMeasure__c |
Picklist |
It is a required field to select a unit of measure of the quota application conditions. Available values:
|
Filling Quota Template
When the quota is automatically created based on the quota template, the following fields inherit values from the template, and the quota has the Individual record type.
| Field | Value |
|---|---|
Account |
orders__orderId__r.orders__AccountId__с |
Active |
true |
Amount Field |
orders__QuotaTemplateId__r.orders__AmountField__c |
End Date |
orders__QuotaTemplateId__r.orders__EndDate__с |
Limit Amount |
orders__QuotaTemplateId__r.orders__LimitAmount__с |
Limit Quantity |
orders__QuotaTemplateId__r.orders__LimitQuantity__с |
Order Type |
orders__QuotaTemplateId__r.orders__OrderType__c |
Product |
orders__QuotaTemplateId__r.ProductId__c or orders__QuotaTemplateId__r.orders__Product2Id__c |
Product Type |
orders__QuotaTemplateId__r.orders__ProductType__с |
Promotion |
orders__QuotaTemplateId__r.orders__PromotionId__с |
Retail Store |
orders__QuotaTemplateId__r.RetailStoreId__с |
Quota Template |
The parent Quota record of the Template type (if exists). |
Record Type |
Individual |
Sales Organization |
orders__QuotaTemplateId__r.orders__SalesOrganizationId__c |
Start Date |
orders__QuotaTemplateId__r.orders__StartDate__с |
User |
orders__OrderId__r.OwnerId |
Unit of Measures |
orders__QuotaTemplateId__r.orders__UnitOfMeasure__с |