Objects that Support Custom Fields in Zuora

Knowledge Center > Zuora Central > Manage Custom Fields > Objects that Support Custom Fields in Zuora

Objects that Support Custom Fields in Zuora

Custom fields allow you to add and store additional information on many objects in Zuora when standard fields do not meet your needs. You must define custom fields from the Zuora UI, then set values to the defined custom fields via UI or API. See Manage Custom Fields for details.

Objects that Support Creating Custom Fields from Zuora UI

Zuora enables you to create custom fields in the following objects from the Zuora UI:

  • Orders Objects
    • Order
    • Order Action
  • Billing Objects
    • Account
    • Amendment
    • Contact
    • Subscription
    • Product
    • Feature
    • Product Rate Plan
    • Product Rate Plan Charge
    • Subscription Rate Plan
    • Subscription Rate Plan Charge
    • Product Feature
    • Subscription Product Feature
    • Invoice Item Adjustment
    • Invoice Adjustment (This object is deprecated on Production)
    • Invoice
    • Invoice Item ("Invoice Detail")
    • Credit Memo
    • Debit Memo
    • Credit Memo Item
    • Debit Memo Item
    • Taxation Item ("Invoice Tax")
    • Credit Memo Taxation Item ("Credit Memo Tax")
    • Debit Memo Taxation Item ("Debit Memo Tax")
    • Usages
  • Payments Objects
    • Refund
    • Payment
    • Payment Method
    • Credit Balance Adjustment
  • Finance Objects
    • Accounting Period
    • Accounting Code
    • Revenue Schedule
    • Revenue Event
    • Journal Entry
    • Journal Entry Item
    • Revenue Event Item
    • Revenue Schedule Item

You can also set values to the custom fields in these objects.

Objects that Support Setting Values to Custom Fields

After creating a custom field in the Zuora UI, you can set the value to this field using either UI or API. Setting values to custom fields is available to all the listed objects from the Zuora UI, but is restricted to only some objects via API.

The following table describes the mapping relationship between objects and the supported custom field operations via API:

Object Set Value to Custom Fields via API Retrieve Value of Custom Fields via API
Order File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Order Action File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Account File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Amendment File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Contact File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Subscription File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Product File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Feature   File:Z_Media/checkmarkGreen_xsm.png
Product Rate Plan File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Product Rate Plan Charge File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Subscription Rate Plan   File:Z_Media/checkmarkGreen_xsm.png
Subscription Rate Plan Charge   File:Z_Media/checkmarkGreen_xsm.png
Product Feature   File:Z_Media/checkmarkGreen_xsm.png
Subscription Product Feature   File:Z_Media/checkmarkGreen_xsm.png
Invoice Item Adjustment   File:Z_Media/checkmarkGreen_xsm.png
Invoice Adjustment (This object is deprecated on Production) File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Invoice File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Invoice Item ("Invoice Detail")   File:Z_Media/checkmarkGreen_xsm.png
Credit Memo File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Debit Memo File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Credit Memo Item File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Debit Memo Item File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Taxation Item ("Invoice Tax") File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Credit Memo Taxation Item ("Credit Memo Tax")   File:Z_Media/checkmarkGreen_xsm.png
Debit Memo Taxation Item ("Debit Memo Tax")   File:Z_Media/checkmarkGreen_xsm.png
Usage File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Refund File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Payment File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Credit Balance Adjustment   File:Z_Media/checkmarkGreen_xsm.png
Payment Method File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Accounting Period File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Accounting Code File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Revenue Schedule File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Revenue Event File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Journal Entry File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Journal Entry Item File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Revenue Event Item File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png
Revenue Schedule Item File:Z_Media/checkmarkGreen_xsm.png File:Z_Media/checkmarkGreen_xsm.png

For the details of these operations or different use cases, see Zuora REST API Reference for more information.

Last modified

Tags

Classifications

(not set)