Skip to navigation
Billing DocumentsCredit Memos

Retrieve a credit memo item

View as Markdown

Note: This operation 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 Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

cmitemidstringRequired

The unique ID of a credit memo item. You can get the credit memo item ID from the response of List credit memo items.

creditMemoKeystringRequired
The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

Headers

Accept-EncodingstringOptional

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-IdsstringOptional

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-VersionstringOptional

The minor API version.

For a list of available minor versions, see API upgrades.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
amountdoubleOptional

The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.

amountWithoutTaxdoubleOptional
The credit memo item amount excluding tax.
appliedAmountdoubleOptional
The applied amount of the credit memo item.
appliedToItemIdstring or nullOptional
The unique ID of the credit memo item that the discount charge is applied to.
commitmentIdstringOptional
The ID of the commitment.
commitmentPeriodIdstringOptional
The ID of the commitment period.
createdByIdstringOptional
The ID of the Zuora user who created the credit memo item.
createdDatestringOptional

The date and time when the credit memo item was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

creditFromItemIdstringOptional
The ID of the credit from item.
creditFromItemSourceenumOptional
The type of the credit from item.
Allowed values:
descriptionstringOptional

The description of the credit memo item.

Note: This field is available only if you are on the latest Zuora API version, or you set the Zuora-Version request header to 257.0 or a later available version.

excludeItemBillingFromRevenueAccountingbooleanOptional

The flag to exclude the credit memo item from revenue accounting.

Note: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

financeInformationobjectOptional
Container for the finance information related to the credit memo item.
idstringOptional
The ID of the credit memo item.
invoiceScheduleIdstringOptional

The ID of the invoice schedule associated with the credit memo item.

Note: This field is available only if you have the Billing Schedule feature enabled.

invoiceScheduleItemIdstringOptional

The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.

Note: This field is available only if you have the Billing Schedule feature enabled.

numberOfDeliveriesdoubleOptional

The number of deliveries dedicated to the Delivery Pricing charges. The value might 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. Note: This field is available only if you have the Delivery Pricing feature enabled.
organizationLabelstringOptional

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

processingTypestringOptional

The kind of the charge for the credit memo item. Its possible values are Charge and Discount.

quantitydoubleOptional
The number of units for the credit memo item.
refundAmountdoubleOptional
The amount of the refund on the credit memo item.
reflectDiscountInNetAmountbooleanOptionalDefaults to false

When you apply percentage discounts to either of the following charges, you need to set the reflectDiscountInNetAmount field on your discount charge to true, to enable calculating and displaying the net amount of the following charges in Zuora Revenue.

  • delivery pricing charge
  • prepayment charge
  • drawdown charge

Note the following:

  • If you are an Order to Revenue customer, when you set the reflectDiscountInNetAmount field to true, you must also set the excludeItemBillingFromRevenueAccounting field to true.
  • If you are a Billing - Revenue Integration customer, you must set the reflectDiscountInNetAmount field to false, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges.
  • If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the reflectDiscountInNetAmount field to true.
revenueImpactingenumOptionalDefaults to Yes

Indicates whether this write off operation impacts the revenue. If revenueImpacting = Yes, the deferred revenue accounting code will be automatically selected from the associated invoice

If revenueImpacting = No, users can select an accounting code such as bad-debt expense accounting code for the write off operation.

Allowed values:
serviceEndDatedateOptional
The service end date of the credit memo item.
serviceStartDatedateOptional

The service start date of the credit memo item. If the associated charge is a one-time fee, this date is the date of that charge.

skustringOptional
The SKU for the product associated with the credit memo item.
skuNamestringOptional
The name of the SKU.
shipToContactIdstringOptional

The ID of the ship-to contact associated with the credit memo item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

soldToContactIdstringOptional

The ID of the sold-to contact associated with the credit memo item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

soldToContactSnapshotIdstringOptional

The ID of the sold-to contact snapshot associated with the credit memo item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

sourceItemIdstringOptional

The ID of the source item.

  • If the value of the sourceItemType field is SubscriptionComponent , the value of this field is the ID of the corresponding rate plan charge.
  • If the value of the sourceItemType field is InvoiceDetail, the value of this field is the ID of the corresponding invoice item.
  • If the value of the sourceItemType field is ProductRatePlanCharge , the value of this field is the ID of the corresponding product rate plan charge.
  • If the value of the sourceItemType field is OrderLineItem , the value of this field is the ID of the corresponding return order line item.
sourceItemTypeenumOptional

The type of the source item.

  • If a credit memo is not created from an invoice or a product rate plan charge or a return order line item,, the value of this field is SubscriptionComponent.
  • If a credit memo is created from an invoice, the value of this field is InvoiceDetail.
  • If a credit memo is created from a product rate plan charge, the value of this field is ProductRatePlanCharge.
  • If a credit memo is created from a return order line item, the value of this field is OrderLineItem.
Allowed values:
subscriptionIdstringOptional
The ID of the subscription associated with the credit memo item.
successbooleanOptional

Returns true if the request was processed successfully.

taxModeenumOptional
The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.
Allowed values:
taxationItemsobjectOptional

Container for the taxation items of the credit memo item.

Note: This field is available only if you are on the latest Zuora API version, or you set the Zuora-Version request header to 239.0 or a later available version.

unappliedAmountdoubleOptional
The unapplied amount of the credit memo item.
unitOfMeasurestringOptional
The units to measure usage.
unitPricedoubleOptional

The per-unit price of the credit memo item.

updatedByIdstringOptional
The ID of the Zuora user who last updated the credit memo item.
updatedDatestringOptional

The date and time when the credit memo item was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-02 15:36:10.

Errors

4XX
Client Request Error
500
Internal Server Error