Skip to navigation
DataZuora ReportingData sources and exportsData source reference

Credit Memo data source

View as Markdown

Data source to export credit memo data, such as amount, balance, and key dates.

This feature is only available if you have Invoice Settlement enabled. 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.

Use this data source to export credit memo data, such as amount, balance, and key dates. Each credit memo represents one row in the export.

Accessing the data source

​Navigation: Reporting > Data Sources and select Credit Memo as the data source.

Base object description

Descriptions for the base Zuora object.

Zuora Object

Description

Credit Memo

Credit memos that you issued to your customers to reduce invoice and account balances. It includes the following fields:

  • Applied Amount
  • Balance
  • Cancelled By Id
  • Cancelled On
  • Comments
  • Created By ID
  • Created Date
  • Credit Memo Date
  • Credit Memo Number
  • Discount Amount
  • Exchange Rate Date (Only available if you have the Currency Conversion feature enabled.)
  • ID
  • Invoice Group Number
  • Posted By ID
  • Posted On
  • Reason Code
  • Refund Amount
  • Sequence Set ID
  • Source
  • Source ID
  • Source Type
  • Status
  • Target DateIf credit memos are created from bill runs, the value of this field is the target date of the corresponding bill run. If credit memos are created from product rate plan charges or invoices, the value of the field is null.
  • Tax Amount
  • Tax Auto Calculation
  • Total Amount
  • Total Amount Without Tax
  • Total Tax Exempt Amount
  • Transferred To Accounting
  • Updated By ID
  • Updated Date

For more information, see View Information of Credit and Debit Memos.

Descriptions for related Zuora objects are listed in alphabetical order.

Zuora Object

Description

Account

The account that made the payment.

Bill To

The Bill-To Contact of the Account.

Billing Document PDF Generation

This represents the current PDF generation status of the document and contains the following fields:

  • Created By ID
  • Created Date
  • Error Category
  • Error Message
  • File ID
  • Generation Source
  • Generation Status
  • ID
  • Updated By ID
  • Updated Date

Alternatively, you can select the Select All “Billing Document PDF Generation” Fields checkbox to include all fields at once.

Credit Memo Bill To Contact

The bill-to contact that is associated with the credit memo.

  • If the credit memo is generated from a subscription and the bill-to contact at the subscription level is not specified, the value is null.
  • If the credit memo is generated from an invoice, the value is the same as the bill-to contact on the invoice.

Credit Memo FX Data

Contains Home Currency and Reporting Currency information.

To enable this option, submit a request at Zuora Global Support.

Default Payment Method

The default payment method used to make payments.

Entity

The entity that the data relates to. Part of the Multi-entity feature. Contains the following fields:

  • Address 1
  • Address 2
  • City
  • Country
  • Created By ID
  • Created Date
  • Display Name
  • Email
  • ID
  • Name
  • Postal Code
  • State
  • Updated By ID
  • Updated Date

Invoice

The invoice to which the payment is applied.

Parent Account

Refers to the parent account associated with the customer account, if applicable.

Sold To

The Sold-To Contact of the Account.

E-Invoice Profile

The e-invoicing profile associated with the customer account. All standard and custom fields on the EInvoiceProfile object are available for export.