--- title: "List credit memo items" method: GET path: "/v1/credit-memos/{creditMemoKey}/items" tags: ["Credit Memos"] --- # List credit memo items `GET /v1/credit-memos/{creditMemoKey}/items` **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate ## Path parameters - `creditMemoKey` string, required ## Query parameters - `page` integer - `pageSize` integer - `amount` number, double - `appliedAmount` number, double - `createdById` string - `createdDate` string, date-time - `id` string - `refundAmount` number, double - `serviceEndDate` string, date - `serviceStartDate` string, date - `sku` string - `skuName` string - `sourceItemId` string - `subscriptionId` string - `updatedById` string - `updatedDate` string, date-time - `sort` string ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - GETCreditMemoItemsListType - `items` GETCreditMemoItemTypewithSuccess[] — Container for credit memo items. - `amount` number, double — 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. - `amountWithoutTax` number, double — The credit memo item amount excluding tax. - `appliedAmount` number, double — The applied amount of the credit memo item. - `appliedToItemId` string, nullable — The unique ID of the credit memo item that the discount charge is applied to. - `commitmentId` string — The ID of the commitment. - `commitmentPeriodId` string — The ID of the commitment period. - `createdById` string — The ID of the Zuora user who created the credit memo item. - `createdDate` string — 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. - `creditFromItemId` string — The ID of the credit from item. - `creditFromItemSource` 'InvoiceItem' | 'CreditMemoItem' — The type of the credit from item. - `description` string — 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](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - `excludeItemBillingFromRevenueAccounting` boolean — 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. - `financeInformation` object — Container for the finance information related to the credit memo item. - `deferredRevenueAccountingCode` string, nullable — The accounting code for the deferred revenue, such as Monthly Recurring Liability. - `deferredRevenueAccountingCodeType` string, nullable — The type of the deferred revenue accounting code, such as Deferred Revenue. - `nonRevenueWriteOffAccountingCode` string — Specify the accounting code for the non revenue write off. Available only if `revenueImpacting` = `no`. - `nonRevenueWriteOffAccountingCodeType` string — Specify the accounting code type for the non revenue write off. - `onAccountAccountingCode` string, nullable — The accounting code that maps to an on account in your accounting system. - `onAccountAccountingCodeType` string, nullable — The type of the accounting code that maps to an on account in your accounting system. - `recognizedRevenueAccountingCode` string, nullable — The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. - `recognizedRevenueAccountingCodeType` string, nullable — The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. - `revenueScheduleNumber` string — Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001. - `id` string — The ID of the credit memo item. - `invoiceScheduleId` string — 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. - `invoiceScheduleItemId` string — 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. - `numberOfDeliveries` number — 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. - `processingType` string — The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. - `quantity` number, double — The number of units for the credit memo item. - `reflectDiscountInNetAmount` boolean — 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`. - `refundAmount` number, double — The amount of the refund on the credit memo item. - `revenueImpacting` 'Yes' | 'No' — 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. - `serviceEndDate` string, date — The service end date of the credit memo item. - `serviceStartDate` string, date — The service start date of the credit memo item. - `sku` string — The SKU for the product associated with the credit memo item. - `skuName` string — The name of the SKU. - `shipToContactId` string — 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`. - `soldToContactId` string — 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`. - `soldToContactSnapshotId` string — 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`. - `sourceItemId` string — 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. - `sourceItemType` 'SubscriptionComponent' | 'InvoiceDetail' | 'ProductRatePlanCharge' | 'OrderLineItem' — 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`. - `subscriptionId` string — The ID of the subscription associated with the credit memo item. - `taxMode` 'TaxExclusive' | 'TaxInclusive' — The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax. - `taxationItems` object — 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](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - `data` GETCMTaxItemTypeNew[] — List of taxation items. - `appliedAmount` number, double — The applied amount of the taxation item. - `exemptAmount` number, double — The calculated tax amount excluded due to the exemption. - `financeInformation` object — Container for the finance information related to the taxation item. - `onAccountAccountingCode` string, nullable — The accounting code that maps to an on account in your accounting system. - `onAccountAccountingCodeType` string, nullable — The type of the accounting code that maps to an on account in your accounting system. - `salesTaxPayableAccountingCode` string, nullable — The accounting code for the sales taxes payable. - `salesTaxPayableAccountingCodeType` string, nullable — The type of the accounting code for the sales taxes payable. - `id` string — The ID of the taxation item. - `jurisdiction` string — The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. - `locationCode` string — The identifier for the location based on the value of the `taxCode` field. - `name` string — The name of the taxation item. - `refundAmount` number, double — The amount of the refund on the taxation item. - `sourceTaxItemId` string, nullable — The ID of the source taxation item. - `taxAmount` number, double — The amount of taxation. - `taxCode` string — The tax code identifies which tax rules and tax rates to apply to a specific credit memo. - `taxCodeDescription` string — The description of the tax code. - `taxDate` string, date — The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format. - `taxRate` number, double — The tax rate applied to the credit memo. - `taxRateDescription` string — The description of the tax rate. - `taxRateType` 'Percentage' | 'FlatFee' — The type of the tax rate. - `unappliedAmount` number, double — The unapplied amount of the taxation item. - `nextPage` string, URL — URL to retrieve the next page of the response if it exists; otherwise absent. - `unappliedAmount` number, double — The unapplied amount of the credit memo item. - `unitOfMeasure` string — The units to measure usage. - `unitPrice` number, double — The per-unit price of the credit memo item. - `updatedById` string — The ID of the Zuora user who last updated the credit memo item. - `updatedDate` string — 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. - `nextPage` string, URL — URL to retrieve the next page of the response if it exists; otherwise absent. - `success` boolean — Returns `true` if the request was processed successfully. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)