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.

Request
path Parameters
dmitemid
required
string

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

debitMemoKey
required
string

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

header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 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-Ids
string

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 do not need to set this header.

zuora-version
string

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following response fields:

  • taxItems
  • taxationItems
  • comment
  • description
Responses
200
get/v1/debitmemos/{debitMemoKey}/items/{dmitemid}
Request samples
Response samples
application/json
{
  • "id": "402890555a87d7f5015a8919e500002f",
  • "amount": 1,
  • "amountWithoutTax": 1,
  • "beAppliedAmount": 0,
  • "balance": 1,
  • "quantity": 1,
  • "taxMode": "TaxExclusive",
  • "sku": "SKU-00000002",
  • "skuName": "ZTax Component",
  • "serviceStartDate": "2017-02-27",
  • "serviceEndDate": "2017-03-26",
  • "sourceItemType": "InvoiceDetail",
  • "sourceItemId": "402890555a7d4022015a7dadb3b700a6",
  • "appliedToItemId": "402890555a7d4022015a2dadb3b700a6",
  • "processingType": "Charge",
  • "createdDate": "2017-03-01 17:01:00",
  • "excludeItemBillingFromRevenueAccounting": true,
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 17:01:00",
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "comment": "aa",
  • "subscriptionId": null,
  • "unitOfMeasure": "Each",
  • "unitPrice": 1,
  • "financeInformation": {
    },
  • "taxationItems": {
    },
  • "success": true
}