Skip to main content

Sync Field Mapping of Product Catalog and Related Objects for Zuora 360+

Zuora

Sync Field Mapping of Product Catalog and Related Objects for Zuora 360+

Product Catalogs can be synced using either Zuora 360 or Zuora 360+. Zuora 360+ allows Product Catalog objects and the corresponding fields to be synced in real time.

To sync Product Catalog objects through Zuora 360+, you must ensure:

This article shows how the Zuora objects and their fields are mapped and synchronized to Salesforce objects and fields in Product Catalog sync.

Each sync objects pair is marked as <Zuora object> : <Salesforce object>. For example, Product : Zuora__Product__c.

Any Zuora field marked as "internal" is a field that is not exposed in the Zuora SOAP API. However, these internal fields are synchronized between Zuora and Salesforce in Zuora 360+.

For the descriptions of the standard fields, refer to SOAP API Objects.

Fields labeled as Deprecated

You might find that the fields where their labels indicate that they have been deprecated also exist on Product Catalog objects. For example:

  • Product SKU (Deprecated)
  • Product Name (Deprecated)
  • Product Effective End Date (Deprecated)
  • UOM (Deprecated)

Do not use such fields in your customizations as they are likely to be removed soon and could result in sync failures. Keep in mind that you should always use the fields without the Deprecated suffix in their labels. Therefore, instead of the fields in the preceding list, you should use the following fields:

  • Product SKU
  • Product Name 
  • Product Effective End Date
  • UOM

Sync Date Fields

When creating products and product rate plans, you must use dates that fall within the range supported by Salesforce: 1700-01-01T00:00:00 GMT to 4000-12-31T00:00:00 GMT. If you set a date outside of this range, the product sync will fail.

  • Effective start date must be on or after 1-1-1700
  • Effective end date must be on or before 12-31-4000

Product : Zuora__Product__c 

Following fields of Zuora Product are synced in Zuora 360+.

Zuora Object Zuora Field Salesforce Object Salesforce Field Comments
Product Zuora__Product__c  
  Category   Zuora__Category__c  
  Description   Zuora__Description__c  
  Effective End Date   Zuora__EffectiveEndDate__c  
  Effective Start Date   Zuora__EffectiveStartDate__c  
  Entity ID   Zuora__EntityID__c  
  External Id   Zuora__External_Id__c  
  SKU   Zuora__SKU__c  
  Zuora Created Date   Zuora__CreatedDate__c  
  Zuora Updated Date   Zuora__UpdatedDate__c  

Product : zqu__ZProduct__c

Refer to this mapping if you are using the 2.x and earlier versions of Zuora 360.

Zuora Object Zuora Field Salesforce Object Salesforce Field
Product zqu__ZProduct__c
  AllowFeatureChanges   zqu__Allow_Feature_Changes__c
  Deleted   zqu__Deleted__c
  Description   zqu__Description__c
  EffectiveEndDate   zqu__EffectiveEndDate__c
  EffectiveStartDate   zqu__EffectiveStartDate__c
  Id   zqu__ZuoraId__c (External ID)
  Name   Name
  SKU   zqu__SKU__c

 

ProductRatePlan : zqu__ProductRatePlan__c

Zuora Object Zuora Field Salesforce Object Salesforce Field Comment
ProductRatePlan zqu__ProductRatePlan__c  
  Active Currencies   zqu__ActiveCurrencies__c  
  Catalog Sync History   zqu__Catalog_Sync_History__c Holds a lookup reference to the Catalog Sync History object.
  Default   zqu__Default__c  
  Deleted   zqu__Deleted__c  
  Description   zqu__Description__c  
  Effective End Date   zqu__EffectiveEndDate__c  
  EffectiveEndDateTEXT   zqu__EffectiveEndDateTEXT__c  
  Effective Start Date   zqu__ EffectiveStartDate__c  
  EffectiveStartDateTEXT   zqu__EffectiveStartDateTEXT__c  
  Entity ID   zqu__EntityID__c  
  Full Name   zqu__ProductRatePlanFullName__c  
  Price Summary   zqu__Price_Summary__c  
  Product   zqu__Product__c Holds a lookup reference to the Product object.
  Sync Message   zqu__SyncMessage__c  
  Sync Status   zqu__SyncStatus__c  
  ZProduct   zqu__ZProduct__c  
  ZuoraId   zqu__ZuoraId__c   

ProductRatePlanCharge : zqu__ProductRatePlanCharge__c

Zuora Object Zuora Field Salesforce Object Salesforce Field Comments
ProductRatePlanCharge zqu__ProductRatePlanCharge__c  
  Accounting Code   zqu__AccountingCode2__c  
  Apply Discount To One Time Charges   zqu__Apply_Discount_To_One_Time_Charges__c  
  Apply Discount To Recurring Charges   zqu__Apply_Discount_To_Recurring_Charges__c  
  Apply Discount To Usage Charges   zqu__Apply_Discount_To_Usage_Charges__c  
  ApplyType (Internal)   zqu__Discount_Apply_Type__c

Specifies the type of
charges a specific
discount applies to.

Contains one of the following 
values as the 
ApplyDiscountTo field of the ProductRatePlanCharge object. 

  • ONETIME (1)
  • RECURRING (2)
  • ONETIMERECURRING (3)
  • USAGE (4)
  • ONETIMEUSAGE (5)
  • RECURRINGUSAGE (6)
  • ONETIMERECURRINGUSAGE (7)
  Bill Cycle Day   zqu__BillCycleDay__c  
  Bill Cycle Type   zqu__BillCycleType__c  
  Billing Period   zqu__RecurringPeriod__c  
  Billing Period Alignment   zqu__BillingPeriodAlignment __c  
  Billing Timing   zqu__BillingTiming__c

Specifies whether to bill this charge in advance or in arrears for recurring charge types. This field is not used in one-time or usage-based charge types.

Contains one of the following:

  • In Advance
  • In Arrears
  Catalog Sync History   zqu__Catalog_Sync_History__c  
  Default Quantity   zqu__DefaultQuantity__c  
  Deferred Revenue Account   zqu__DeferredRevenueAccount__c  
  Deleted   zqu__Deleted__c  
  Description   zqu__Description__c  
  Discount - Apply Type   zqu__Discount_Apply_Type__c  
  Discount Class   zqu__Discount_Class__c  
  Discount Level   zqu__Discount_Level__c Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.
  End Date Condition   zqu__EndDateCondition
__c
 
  Entity ID   zqu__EntityID__c  
  Full Name   zqu__ProductRatePlanChargeFullName__c  
  Included Units   zqu__IncludedUnits__c  
  List Price   zqu__ListPrice__c  
  List Price Base   zqu__ListPriceBase__c  
  Maximum Quantity   zqu__MaxQuantity__c  
  Minimum Quantity   zqu__MinQuantity__c  
  Model   zqu__Model__c  
  Number Of Period   zqu__NumberOfPeriod__c  
  Overage Calculation Option   zqu__OverageCalculationOption__c  
  Overage Unused Units Credit Option   zqu__OverageUnusedUnitsCreditOption __c  
  Prepaid Periods   zqu__PrepaymentPeriods __c The number of periods to which prepayment is set.
  Price Change Option   zqu__PriceChangeOption__c  
  Price Increase Percentage   zqu__PriceIncreasePercentage__c  
  Price Table   zqu__PriceTable__c  
  Product Rate Plan   zqu__ProductRatePlan__c  
  Product Rate Plan Charge Name   zqu__ProductRatePlanChargeName__c  
  Rating Group   zqu__RatingGroup__c  
  Recognized Revenue Account   zqu__
RecognizedRevenueAccount__c
 
  Recognize revenue without deferral   zqu__Recognize_revenue_without_deferral__c  
  Revenue Recognition Rule Name   zqu__
RevenueRecognition
RuleName__c
 
  Rev Rec Code   zqu__RevRecCode__c This mapping is deprecated in Zuora 360 3.1 and higher versions.
  Rev Rec Code   zqu__RevRecCode2__c Applicable to Zuora 360 3.1 and higher versions.
  Rev Rec Trigger Condition   zqu__RevRecTriggerCondition __c

Specifies when revenue recognition begins.
Contains one of the following values:

  • ContractEffectiveDate
  • ServiceActivationDate
  • CustomerAcceptanceDate
  Smoothing Model   zqu__SmoothingModel__c  
  Specific Billing Period   zqu__SpecificBillingPeriod__c  
  Sync Message   zqu__SyncMessage__c  
  Sync Status   zqu__SyncStatus__c  
  UOM   zqu__UOM__c  
  Uom Id   zqu__ZUom_Id__c Zuora ID of the UOM
  UOM   zqu__ZUnitOfMeasure__c References to the zqu__ZUnitOfMeasure__c object, which maps to the UnitOfMeasure object in Zuora.
  Taxable   zqu__Taxable__c  
  Tax Code   zqu__TaxCode2__c  
  Tax Mode   zqu__TaxMode__c  
  Trigger Event   zqu__TriggerEvent__c  
  Up To How Many Periods   zqu__Upto_How_Many_Periods__c Specifies the number of billing periods for which a discount is applied to the charge.
  Up To Periods Type   zqu__UpToPeriodsType__c  
  Usage Record Rating Option   zqu__UsageRecordRatingOption__c  
  Use Discount Specific Accounting Code   zqu__UseDiscountSpecificAccountingCode __c  
  Use Tenant Default
For Price Change
  zqu__UseTenantDefaultForPriceChange __c  
  Weekly Bill Cycle Day   zqu__WeeklyBillCycleDay__c  
  Zuora Id   zqu__ZuoraId__c  

ProductRatePlanChargeTier : zqu__ProductRatePlanChargeTier__c

Zuora Object Zuora Field Salesforce Object Salesforce Field
ProductRatePlanChargeTier zqu__ProductRatePlanChargeTier__c
  Active   zqu__Active__c
  Catalog Sync History   zqu__Catalog_Sync_History__c
  Currency   zqu__Currency2__c
  Deleted   zqu__Deleted__c
  Discount Amount   zqu__DiscountAmount__c
  Discount Percentage   zqu__DiscountPercentage__c
  Ending Unit   zqu__EndingUnit__c
  Zuora Id   zqu__ZuoraId__c 
  Entity ID   zqu__EntityID__c
  Is Overage Price   zqu__IsOveragePrice__c
  Price   zqu__Price__c
  PriceFormat   zqu__PriceFormat2__c
  Product Rate Plan Charge   zqu__ProductRatePlanCharge__c
  ProductRatePlanChargeId   zqu__ProductRatePlanChargeId__c
  Starting Unit   zqu__StartingUnit__c
  Sync Message   zqu__SyncMessage__c
  Sync Status   zqu__SyncStatus__c
  Tier   zqu__Tier__c

Feature : zqu__ZFeature__c

To create features in the product catalog and use them in subscriptions and Zuora Quotes, you need to enable the following:

Zuora Object Zuora Field Salesforce Object Salesforce Field
Feature zqu__ZFeature__c
  Zuora Id zqu__ZuoraId__c  
  Billing Entity zqu__BillingEntity__c  
  Catalog Sync History zqu__Catalog_Sync_History__c  
  EntityID zqu__EntityID__c  
  Full Name zqu__FeatureName__c  
  Code zqu__Code__c  
  Description zqu__Description__c  
  Deleted zqu__Deleted__c  
  Status zqu__Status2__c  
  Sync Message zqu__SyncMessage__c  
  Sync Status zqu__SyncStatus__c  

ProductFeature : zqu__ZProductFeature__c

To create features in the product catalog and use them in subscriptions and Zuora Quotes, you need to enable the following:

Zuora Object Zuora Field Salesforce Object Salesforce Field Comments
ProductFeature zqu__ZFeature__c  
  Catalog Sync History   zqu__Catalog_Sync_History__c  
  Deleted   zqu__Deleted__c  
  EntityID   zqu__EntityID__c  
  Zuora Id   zqu__ZuoraId__c  
  Feature   zqu__ZFeature__c

Holds a lookup reference to the Feature object

  Full Name   zqu__ZProductFeatureFullName__c  
  Product   zqu__Product__c Holds a lookup reference to the Product object.
  Sync Message   zqu__SyncMessage__c  
  Sync Status   zqu__SyncStatus__c  
  ZProduct   zqu__ZProduct__c Holds a lookup reference to the ZProduct object