Sign in
Debit Memos

Retrieve a debit memo item

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 information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.

get/v1/debit-memos/{debitMemoKey}/items/{dmitemid}

Path parameters

dmitemidstring required

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

debitMemoKeystring required

The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

Headers

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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-Versionstring

The minor API version.

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

Response

OK

amountnumber double

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

amountWithoutTaxnumber double

The debit memo item amount excluding tax.

appliedToItemIdstring

The parent debit memo item that this debit memo items is applied to if this item is discount.

balancenumber double

The balance of the debit memo item.

beAppliedAmountnumber double

The applied amount of the debit memo item.

createdByIdstring

The ID of the Zuora user who created the debit memo item.

createdDatestring

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

descriptionstring

Description about the debit memo item.

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

excludeItemBillingFromRevenueAccountingboolean

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

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

idstring

The ID of the debit memo item.

processingTypestring

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

quantitynumber double

The number of units for the debit memo item.

reflectDiscountInNetAmountboolean

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 <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> customer, when you set the reflectDiscountInNetAmount field to true, you must also set the excludeItemBillingFromRevenueAccounting field to true.
  • If you are a <a href="https://docs.zuora.com?resourceId=revenue-billing-integration" target="_blank">Billing - Revenue Integration</a> 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.
serviceEndDatestring date

The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.

serviceStartDatestring date

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

skustring

The SKU for the product associated with the debit memo item.

skuNamestring

The name of the SKU.

shipToContactIdstring

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

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

soldToContactIdstring

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

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

soldToContactSnapshotIdstring

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

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

sourceItemIdstring

The ID of the source item.

sourceItemType'CreditMemoItem' | 'SubscriptionComponent' | 'InvoiceDetail' | 'ProductRatePlanCharge'

The type of the source item.

subscriptionIdstring nullable

The ID of the subscription associated with the debit memo item.

successboolean

Returns true if the request was processed successfully.

taxMode'TaxExclusive' | 'TaxInclusive'

The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.

unitOfMeasurestring

The units to measure usage.

unitPricenumber double

The per-unit price of the debit memo item.

updatedByIdstring

The ID of the Zuora user who last updated the debit memo item.

updatedDatestring

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

Changes