Fields supported by segments
Learn about the fields supported by segments
This reference article lists the fields that you can associate with segments in Zuora.
Custom fields
Any custom fields that you have created for a supported object will appear in the Field drop-down menu for that object on the Finance Settings > Configure Segments page in Zuora. For information about custom fields, see Custom fields .
Supported fields
The following table provides a list of fields that can be associated segments and shows which of the objects support custom fields:
|
Zuora object |
Custom fields allowed |
Field |
|---|---|---|
|
Customer objects | ||
|
Account |
|
AccountNumber |
|
AutoPay | ||
|
Batch | ||
|
BillCycleDay | ||
|
CustomerServiceRepName | ||
|
PaymentGateway | ||
|
InvoiceDeliveryPrefsEmail | ||
|
InvoiceDeliveryPrefsPrint | ||
|
Name | ||
|
PaymentTerm | ||
|
Status | ||
|
SalesRepName | ||
|
TaxExemptStatus | ||
|
Bill To Contact |
|
City |
|
Country | ||
|
County | ||
|
State | ||
|
TaxRegion | ||
|
Sold To Contact |
|
City |
|
Country | ||
|
County | ||
|
State | ||
|
TaxRegion | ||
|
Default Payment Method |
|
Payment Method Type |
|
Credit Card Type | ||
|
Parent Account |
|
AccountNumber |
|
AutoPay | ||
|
Batch | ||
|
BillCycleDay | ||
|
CustomerServiceRepName | ||
|
PaymentGateway | ||
|
InvoiceDeliveryPrefsEmail | ||
|
InvoiceDeliveryPrefsPrint | ||
|
Name | ||
|
PaymentTerm | ||
|
Status | ||
|
SalesRepName | ||
|
TaxExemptStatus | ||
|
Product objects | ||
|
Product |
|
Name |
|
SKU | ||
|
Product Rate Plan |
|
Name |
|
Product Rate Plan Charge |
|
BillingPeriod |
|
ChargeModel | ||
|
ChargeType | ||
|
Name | ||
|
RevenueRecognitionRuleName | ||
|
Taxable | ||
|
TaxCode | ||
|
TaxMode | ||
|
Order Line Item |
|
ItemName |
|
ItemState | ||
|
ItemType | ||
|
ProductCode | ||
|
ItemCategory | ||
|
Currency | ||
|
BillingRule | ||
|
RevenueRecognitionRule | ||
|
TaxCode | ||
|
TaxMode | ||
|
Subscription objects | ||
|
Subscription |
|
AutoRenew |
|
Status | ||
|
TermType | ||
|
Subscription Rate Plan |
|
Name |
|
Subscription Rate Plan Charge |
|
BillingPeriod |
|
RevenueRecognitionRuleName | ||
|
Transaction objects | ||
|
Invoice |
|
Invoice Date |
|
Due Date | ||
|
Invoice Item |
|
Processing Type |
|
Taxation Item |
|
Tax Date |
|
Tax Name | ||
|
Jurisdiction | ||
|
Location Code | ||
|
Invoice Item Adjustment |
|
Adjustment Date |
|
Adjustment Type | ||
|
Reference ID | ||
|
Reason Code | ||
|
Invoice Adjustment Note: Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead. |
|
Adjustment Date |
|
Adjustment Type | ||
|
Reference ID | ||
|
Reason Code | ||
|
Payment |
|
Effective Date |
|
Reference ID | ||
|
Gateway | ||
|
Refund |
|
Refund Date |
|
Reference ID | ||
|
Reason Code | ||
|
Gateway | ||
|
Refund Method Type | ||
|
Payment Method |
|
Payment Method Type |
|
Credit Card Type | ||
|
Credit Balance Adjustment |
|
Adjustment Date |
|
Reference ID | ||
|
Reason Code | ||
|
Revenue Schedule |
|
Revenue Schedule Date |
|
Recognition Rule Name | ||
|
Revenue Event |
|
Only custom fields on this object can be associated with segments. |
|
Revenue Event Item |
|
Only custom fields on this object can be associated with segments. |
|
Revenue Event Type |
|
Label |
|
System ID | ||
|
The following fields are only available if you enable the Invoice Settlement feature. Note:
The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memos, and Invoice Item Settlement. If you want to have access to the feature, see Invoice Settlement Enablement and Checklist Guide for more information. After Invoice Settlement is enabled, the Invoice Item Adjustment feature will be deprecated for your tenant. | ||
|
Credit Memo |
|
MemoDate |
|
Credit Memo Item |
|
ProcessingType |
|
Credit Memo Item Tax |
|
Tax Date |
|
Tax Name | ||
|
Jurisdiction | ||
|
Location Code | ||
|
Debit Memo |
|
DueDate |
|
MemoDate | ||
|
Debit Memo Item |
|
ProcessingType |
|
Debit Memo Item Tax |
|
Tax Date |
|
Tax Name | ||
|
Jurisdiction | ||
|
Location Code | ||