Skip to main content

View information of credit and debit memos

Zuora

View information of credit and debit memos

After you have created a credit or debit memo, you can find the memo by navigating to Billing > Credit and Debit Memos in the left-hand navigation section from the Zuora UI. To view information about a memo, click the memo number in the Credit Memo or Debit Memo tab. This takes you to a page with detailed information about that memo. The memo number is displayed at the top of a detail memo page.

  • You can specify the currency when creating a standalone credit or debit memo from a product rate plan charge. By default, the account default currency is selected. You can change it to any currency that is active in your billing setting.

    You must have the Multiple Currencies feature enabled to change the currency value.

To retrieve memo information from the REST API:

Memo status

The following table describes the memo statuses.

Field Description

Draft

The credit or debit memo that has been created but has not been posted.

Posted

The credit or debit memo has been posted.

  • For a credit memo, the memo is now ready to be applied to pay invoices or debit memos. 
  • For a debit memo, the memo is now ready for payments to be collected.

Canceled

The credit or debit memo has been canceled. 

Basic information

The following table describes the basic information about memos.

Field Description

Memo Type

The type of the memo:

  • Credit memo
  • Debit memo

Customer Account

The customer account that the memo belongs to.
Source Only visible for credit memos that are generated by bill runs. The IDs of the bill run from which the credit memo is generated.

Related Invoice

The invoice number that the memo is related to. This field is only applicable if you create memos from invoices.

Amount

The total amount of this memo. It will be different from the 'Amount' listed in the Tax Message field if the memo item is tax-exclusive. 

Balance

Only visible for debit memos. The total amount that your customer owes to you for this memo. 

Unapplied Amount

Only visible for credit memos. The amount of the credit memo that is not applied. 

Refund Amount

Only visible for credit memos. The amount of the credit memo that refunds to your customer.

Memo Date

The date when this memo is created. If the credit memo is created by bill runs, the memo date is the invoice date.
Reversed Only visible for credit memos. Whether a credit memo is reversed.
Auto-Pay Only visible for debit memos. Whether debit memos are automatically picked up for processing in the corresponding payment run.

Auto Apply: Apply to this invoice upon posting

Only visible if you create credit memos from invoices. Specifies whether to auto-apply this memo to pay the associated invoice after the memo is posted. The associated invoice is the one you selected from the Invoice list.

Auto Apply: Exclude from auto apply rules

Only visible for credit memos. Specifies whether to apply the payment run processing rule to this memo. The payment run processing rule is to auto-apply the unapplied credit memos on invoices and debit memos during the payment runs. For more information, see Creating a Payment Run.

Reason Code

The reason why you want to create this memo.

Comments

The note of the memo. 

Transferred to Accounting

The status of the mapping from Zuora to a third party, such as NetSuite or Salesforce. You can only edit this field when the memo is posted.

Supported values are:

  • No
  • Processing
  • Yes
  • Error
  • Ignore
Tax Status

The status of tax calculation related to the credit or debit memo.

  • Complete: The tax calculation is successful and complete.
  • Error: An error occurs in tax calculation.

This field is only applicable to tax calculation by third-party tax engines.

Tax Message

The message about the status of tax calculation related to the credit or debit memo. If tax calculation fails in one credit or debit memo, this field displays the reason for the failure.

This field is only applicable to tax calculation by third-party tax engines.

Memo item detailed information

The following table describes the information for memo items.

Field Description

Charge Name

The charge name of the memo item.

If a credit memo is generated from a bill run, when hovering a charge name displayed in this column, you can now see a floating window displaying detailed information about the invoice where the credit is from.

Credit From The invoice where the credit is from. This column is only displayed for the credit memos that are created from invoices.

Revenue Schedule

The revenue schedule of the memo.
Service Period

The service period of this memo.

If the memo is created from a product rate plan charge, the service period of this memo is the same as the effective period of the corresponding product rate plan by default.

Amount 

The amount of the adjusted invoice item or charge amount in this memo. If the memo item is tax-exclusive, this amount does not include tax; if the memo item is tax-inclusive, this amount includes tax. 
Tax Amount The total tax amount of this memo.
Tax Unapplied Amount The tax amount that is not applied.
Applied Tax Amount Only visible for credit memos through the UI. The sum of the tax amounts of all applied credit memo items.

Balance

Only visible for debit memos. The total amount that your customer owes to you for this memo. 

Unapplied Amount

Only visible for credit memos. The amount of credit that is not applied to pay invoices or debit memos.

Refund Amount Only visible for credit memos. The amount of the credit memo that refunds to your customer.

Action

Edit or view the information about service periods and accounting codes. You can edit the information only if the memo is in draft status.

Item Name

The name of the memo item.

Item Amount

The amount of the adjusted invoice item or charge amount in this memo.
QTY The number of units for the credit memo item.  The value is always 1 for the Delivery Pricing charges.
Number of Deliveries

The number of deliveries dedicated to the Delivery Pricing charges, the value may be different, as follows:

  • For the credit memo generated by a bill run, this field has a value.
  • For the credit memo generated from an invoice, this field is blank.

Comment

The note of the memo. 

Service Period Start

The service period start date of this memo.

Service Period End

The service period end date of this memo.

Recognized Revenue

The accounting code of the recognized revenue.

Deferred Revenue

The accounting code of the deferred revenue.

On-Account

The accounting code of the on-account. On-account specifies the credit that is in your customer account and is not applied to pay invoices or debit memos.

Revenue Recognition Rule

The revenue recognition rule that governing the revenue schedule for this memo.

History

In the History section of the memo detail page, you can perform the following operations:

  • Check the date and time when the memos are created, posted, and emailed.
  • View and download a specific version of the memo.
  • Email a specific version of the memo.

Mapping between AQuA results and meaningful values

When you use the Aggregate Query API (AQuA) to query detailed information about credit memo items, the value of the ProcessingType field in the query result is a numeral. The following table lists the mapping between the AQuA results and meaningful values of the ProcessingType field value:

AQuA query result Meaningful value
0 Charge
1 Discount
2 Prepayment
3 Tax
4 Rounding