Use this data source to retrieve the rating result of a billing period in near real time.
Navigate to Reporting > Data Sources and select Rating Result from the Data Source list in the Basic Information section.
Base object
The following table lists the fields available in the Rating Result base object.
Object |
Description |
Rating Result |
The rating result of a billing period. It contains the following fields:
- Amount
- Charge Segment Number
- Created By ID
- Created Date
- ID
- Is Partial
- Quantity
- Service End Date
- Service Start Date
- Status
- Updated By ID
- Updated Date
|
Related objects
The following table lists the related objects of the Rating Result object in alphabetical order.
Object |
Description |
Account |
The customer account. It contains the following fields:
- Account Balance
- Account Number
- Additional Email Addresses
- Allow Invoice Editing
- Auto Pay
- Bill Cycle Day
- Bill Cycle Day Setting Option
- Billing Batch
- CMRR
- CRM Account ID
- CSR
- CommunicationProfile ID - In the case that this field has no value, the system will use the default Communication Profile to send out notifications.
- Created By ID
- Created Date
- Credit Balance
- Currency
- Default Payment Method ID
- ID
- Invoice Delivery Preferences Email
- Invoice Delivery Preferences Print
- Invoice Template ID
- Last Invoice Date
- Name
- Notes
- PO Number
- Parent ID
- Payment Gateway Name
- Payment Term
- Sales Rep
- Sequence Set ID
- Status
- Tax Company Code
- Tax Exempt Certificate ID
- Tax Exempt Certificate Type
- Tax Exempt Description
- Tax Exempt Effective Date
- Tax Exempt Expiration Date
- Tax Exempt Issuing Jurisdiction
- Tax Exempt Status
- Total Debit Memo Balance - This field is only used for Credit and Debit Memo.
- Total Invoice Balance
- Unapplied Balance - The value of this field is the unapplied payment amount.
- Unapplied Credit Memo Amount - This field is only used for Credit and Debit Memo.
- Updated By ID
- Updated Date
- VAT ID
|
Bill To |
The contact of the entity/person to whom you bill for your product or service. It contains the following fields:
- Account ID
- Address 1
- Address 2
- City
- Country
- County
- Created By ID
- Created Date
- Description
- Fax
- First Name
- Home Phone
- ID
- Last Name
- Mobile Phone
- Nick Name
- Other Phone
- Other Phone Type
- Personal Email
- Postal Code
- State/Province
- Tax Region
- Updated By ID
- Updated Date
- Work Email
- Work Phone
|
Default Payment Method |
The default payment method to be used for making payments. Required to be ACH, credit card, or PayPal for customers paying electronically. It contains the following fields:
- ACH ABA Code
- ACH Account Name
- ACH Account Number Mask
- ACH Account Type
- ACH Address1
- ACH Address2
- ACH Bank Name
- ACH City
- ACH Country
- ACH Postal Code
- ACH State
- Account ID
- Active
- Bank Branch Code
- Bank Check Digit
- Bank City
- Bank Code
- Bank Identification Number
- Bank Name
- Bank Postal Code
- Bank Street Name
- Bank Street Number
- Bank Transfer Account Name
- Bank Transfer Account Number Mask
- Bank Transfer Account Type
- Bank Transfer Type
- Business Identification Code
- City
- Company Name
- Country
- Created By ID
- Created Date
- Credit Card Address 1
- Credit Card Address 2
- Credit Card City
- Credit Card Country
- Credit Card Expiration Month
- Credit Card Expiration Year
- Credit Card Holder Name
- Credit Card Mask Number
- Credit Card Postal Code
- Credit Card State
- Credit Card Type
- Device Session ID
- Email
- Existing Mandate
- First Name
- IBAN
- ID
- IP Address
- Identity Number
- Is a company
- Last Failed Sale Transaction Date
- Last Name
- Last Transaction Date
- Last Transaction Status
- Mandate Creation Date
- Mandate ID
- Mandate Reason
- Mandate Received
- Mandate Status
- Mandate Update Date
- Max Consecutive Payment Failures
- Method Reference Id
- Method Specific Data
- Name
- Number of Consecutive Failures
- Payment Method Status
- Payment Retry Window
- Paypal BAID
- Paypal Email
- Paypal Preapproval Key
- Paypal Type
- Phone
- Postal Code
- Second Token ID
- State
- Street Name
- Street Number
- Sub-Type
- Token ID
- Total Number Of Error Payments
- Total Number Of Processed Payments
- Type
- Updated By ID
- Updated Date
- Use Default Retry Rule
- User Reference Id
|
Invoice |
Invoices that reflect the subscription rate plan charges that have not been billed. It contains the following fields:
- Adjustment Amount
- Amount
- Amount Without Tax
- Auto Pay
- Balance
- Comments
- Created By ID
- Created Date
- Credit Balance Adjustment Amount
- Due Date
- Entity
- ID
- Includes One Time
- Includes Recurring
- Includes Usage
- Invoice Date
- Invoice Number
- Last Email Sent Date
- Payment Amount
- Payment Term - The payment term that is used to calculate the due date on the invoices, which is generated from the corresponding subscription. The value of this field is the name of the payment term. If the payment term is not specified at the subscription level, the field value is null at the invoice level.
- Posted By
- Posted Date
- Refund Amount
- Retry Status
- Reversed
- Sequential Invoice Number
- Source
- Source ID
- Source Type
- Status
- Target Date
- Tax Amount
- Tax Exempt Amount
- Transferred To Accounting
- Updated By ID
- Updated Date
|
Invoice Item |
The items of invoices. It contains the following fields:
- Accounting Code
- Applied To Invoice Item Id
- Balance
- Booking Reference
- Charge Amount
- Charge Date
- Charge Name
- Created By ID
- Created Date
- Exclude Item Billing From Revenue Accounting
- ID
- Processing Type
- Quantity
- Revenue Recognition Start Date
- SKU
- Service End Date
- Service Start Date
- Source Item Type
- Subscription ID
- Tax Amount
- Tax Code
- Tax Exempt Amount
- Tax Mode
- UOM
- Unit Price
- Updated by ID - When Journal Entry ID or Journal Run ID is created, this field will not be updated.
- Updated Date - When Journal Entry ID or Journal Run ID is created, this field will not be updated.
|
Parent Account |
Parent account associated with the customer account, if applicable. It contains the following fields:
- Account Balance
- Account Number
- Additional Email Addresses
- Allow Invoice Editing
- Auto Pay
- Bill Cycle Day
- Bill Cycle Day Setting Option
- Billing Batch
- CMRR
- CRM Account ID
- CSR
- CommunicationProfile ID
- Created By ID
- Created Date
- Credit Balance
- Currency
- Default Payment Method ID
- ID
- Invoice Delivery Preferences Email
- Invoice Delivery Preferences Print
- Invoice Template ID
- Last Invoice Date
- Name
- Notes
- PO Number
- Parent ID
- Payment Gateway Name
- Payment Term
- Sales Rep
- Sequence Set ID
- Status
- Tax Company Code
- Tax Exempt Certificate ID
- Tax Exempt Certificate Type
- Tax Exempt Description
- Tax Exempt Effective Date
- Tax Exempt Entity/Use Code
- Tax Exempt Expiration Date
- Tax Exempt Issuing Jurisdiction
- Tax Exempt Status
- Total Debit Memo Balance
- Total Invoice Balance
- Unapplied Balance
- Unapplied Credit Memo Amount
- Updated By ID
- Updated Date
- VAT ID
|
Product |
The product information. It contains the following fields:
- AllowFeatureChanges
- Category
- Created By ID
- Created Date
- Description
- Effective End Date
- Effective Start Date
- ID
- Name
- SKU
- Updated By ID
- Updated Date
|
Product Rate Plan |
The rate plan of the product. It contains the following fields:
- Created By ID
- Created Date
- Description
- Effective End Date
- Effective Start Date
- ID
- Name
- Updated By Id
- Updated Date
|
Product Rate Plan Charge |
The rate plan charge of the product. It contains the following fields:
- Accounting Code
- Apply Discount To
- Bill Cycle Day
- Bill Cycle Type
- Billing Period
- Billing Period Alignment
- Billing Timing
- Charge Model
- Charge Type
- Created By ID
- Created Date
- Credit Option - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Default Quantity
- Deferred Revenue Account
- Description
- Discount Class ID
- Discount Level
- Drawdown Rate - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Drawdown UOM - This field is only available if you have the Prepaid with Drawdown feature enabled.
- End Date Condition
- Exclude Item Booking from Revenue - Specifies whether to exclude non-revenue related rate plan charges and order line items from syncing to Zuora Revenue. This field is only available if you have enabled Zuora Billing - Revenue Integration.
- Exclude Item Billing from Revenue - Specifies whether to exclude non-revenue related invoice items, invoice item adjustments, credit memo items, and debit memo items from syncing to Zuora Revenue. This field is only available if you have enabled Zuora Billing - Revenue Integration.
- ID
- Included Units
- Is Prepaid - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Legacy Revenue Reporting
- List Price Base
- Max Quantity
- Min Quantity
- Name
- Number of Period
- Overage Calculation Option
- Overage Unused Units Credit Option
- Prepaid Operation Type - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid Quantity - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid Total Quantity - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid UOM - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Price Change Option
- Price Increase Percentage
- Rating Group
- Recognized Revenue Account
- Revenue Recognition Code
- Revenue Recognition Rule Name
- Revenue Recognition Trigger
- Smoothing Model
- Specific Billing Period
- Tax Code
- Tax Mode
- Taxable
- Trigger Event
- UOM
- Up To How Many Periods
- Up To Periods Type
- Updated By ID
- Updated Date
- Usage Records Rating Option
- Use Discount Specific Accounting Code
- Use Tenant Default For Price Change
- Validity Period Type - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Weekly Bill Cycle Day
|
Rate Plan |
The rate plan or pricing plan information associated with the subscription. It contains the following fields:
- Amendment Type - A filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field.
- Created By ID
- Created Date
- Externally Managed Plan ID - This field is a text field. This field indicates the unique identifier of a rate plan purchased from a third-party store.
- ID
- Invoice Owner ID - The invoice owner ID of the subscription that contains the rate plan.
- Name
- Subscription Owner ID - The subscription owner ID of the subscription that contains the rate plan.
- Updated By ID
- Updated Date
|
Rate Plan Charge |
The charge of the rate plan. It contains the following fields:
- Accounting Code
- Apply Discount To
- Bill Cycle Day
- Bill Cycle Type
- Billing Period
- Billing Period Alignment
- Billing Timing
- Charge Model
- Charge Number
- Charge Type
- Charged Through Date - The date through which a customer has been billed for the charge.
- Created By ID
- Created Date
- Credit Option - This field is only available if you have the Prepaid with Drawdown feature enabled.
- DMRC
- DTCV
- Description
- Discount Level
- Drawdown Rate - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Drawdown UOM - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Effective End Date
- Effective Start Date
- End Date Condition
- Exclude Item Booking from Revenue - Specifies whether to exclude non-revenue related rate plan charges and order line items from syncing to Zuora Revenue. This field is only available if you have enabled Zuora Billing - Revenue Integration.
- Exclude Item Billing from Revenue - Specifies whether to exclude non-revenue related invoice items, invoice item adjustments, credit memo items, and debit memo items from syncing to Zuora Revenue. This field is only available if you have enabled Zuora Billing - Revenue Integration.
- ID
- Invoice Owner ID - The invoice owner ID of the subscription that contains the rate plan charge.
- Is Last Segment
- Is Prepaid - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Is Processed - It indicates whether a charge segment has been completely billed for all its relevant billing periods. This is determined by whether the End Date of the charge is earlier than or equal to the Target Date when generating invoices.
- List Price Base
- MRR
- Name
- Number of Periods
- Original ID
- Overage Calculation Option
- Overage Unused Units Credit Option
- Payment Term Snapshot
- Prepaid Operation Type - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid Quantity - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid Total Quantity - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Prepaid UOM - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Price Change Option
- Price Increase Percentage
- Processed Through Date - The date until when charges have been processed. When billing in arrears, such as usage, this field value is the same as the
ChargedThroughDate value. This date is the earliest date when a charge can be amended.
- Quantity
- Rating Group
- Revenue Recognition Code
- Revenue Recognition Rule Name
- Revenue Recognition Trigger Condition
- Segment
- Subscription ID - The ID of the subscription that contains the rate plan charge.
- Subscription Owner ID - The subscription owner ID of the subscription that contains the rate plan charge.
- Specific Billing Period
- Specific End Date
- TCV
- Trigger Date
- Trigger Event
- Unit of Measure
- Up To Periods
- Up To Periods Type
- Updated By ID
- Updated Date - When Charged Through Date, Processed Through Date, or Is Processed is updated, the value of Updated Date for the Rate Plan Charge does not change.
- Validity Period Type - This field is only available if you have the Prepaid with Drawdown feature enabled.
- Version
- Weekly Bill Cycle Day
|
Sold To |
The contact of the entity or person to whom your product or service is sold. It contains the following fields:
- Account ID
- Address 1
- Address 2
- City
- Country
- County
- Created By ID
- Created Date
- Description
- Fax
- First Name
- Home Phone
- ID
- Last Name
- Mobile Phone
- Nick Name
- Other Phone
- Other Phone Type
- Personal Email
- Postal Code
- State/Province
- Tax Region
- Updated By ID
- Updated Date
- Work Email
- Work Phone
|
Subscription |
The information on subscriptions and associated accounts. It contains the following fields:
- Auto Renew
- Cancel Reason - The reason for a subscription cancellation copied from the
changeReason field of a Cancel Subscription order action. This field contains valid value only if a subscription is canceled through the Orders UI or API. Otherwise, the value for this field will always be null .
- Cancelled Date
- Contract Acceptance Date
- Contract Effective Date
- Cpq Bundle Json ID
- Created By ID
- Created Date
- Creator Account ID
- Creator Invoice Owner ID
- Current Term
- Current Term Period Type
- Externally Managed By
- ID
- Initial Term
- Initial Term Period Type
- Invoice Owner ID
- Invoice Separate
- Is Latest Version - Indicates whether the current subscription object is the latest version.
- Last Booking Date - The last change date of a subscription. The value of this field is as follows:
- For a new subscription created by the Subscribe and Amend APIs and UI, this field has the value of the subscription creation date.
- For a subscription changed by an amendment, this field has the value of the amendment booking date.
- For a subscription created or changed by an order, this field has the value of the order date.
- Name
- Notes
- Opportunity Close Date
- Opportunity Name
- Original Created Date
- Original ID
- Payment Term
- Previous Subscription ID
- Quote Business Type
- Quote Number
- Quote Type
- Ramp ID - Indicates the ramp that is related to this subscription. Note that this field is only available if you have enabled the Ramps feature.
- Renewal Setting
- Renewal Term
- Renewal Term Period Type
- Revision
- Service Activation Date
- Status
- Subscription End Date
- Subscription Start Date
- Term End Date
- Term Start Date
- Term Type
- Updated by ID
- Updated Date
- Version
|