List debit memo items

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 all items of a debit memo. A debit memo item is a single line item in a debit 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/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100
/v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate

Request

path Parameters

debitMemoKey

required

string

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

query Parameters

page	integer >= 1 Default: 1 The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
pageSize	integer <= 40 Default: 20 The number of records returned per page in the response.
amount	number <double> This parameter filters the response based on the `amount` field.
beAppliedAmount	number <double> This parameter filters the response based on the `beAppliedAmount` field.
createdById	string This parameter filters the response based on the `createdById` field.
createdDate	string <date-time> This parameter filters the response based on the `createdDate` field.
id	string This parameter filters the response based on the `id` field.
serviceEndDate	string <date> This parameter filters the response based on the `serviceEndDate` field.
serviceStartDate	string <date> This parameter filters the response based on the `serviceStartDate` field.
sku	string This parameter filters the response based on the `sku` field.
skuName	string This parameter filters the response based on the `skuName` field.
sourceItemId	string This parameter filters the response based on the `sourceItemId` field.
subscriptionId	string This parameter filters the response based on the `subscriptionId` field.
updatedById	string This parameter filters the response based on the `updatedById` field.
updatedDate	string <date-time> This parameter filters the response based on the `updatedDate` field.
sort	string This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: operator field_name You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. The `-` operator indicates an ascending order. The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: id amount beAppliedAmount sku skuName serviceStartDate serviceEndDate sourceItemId createdDate createdById updatedDate updatedById subscriptionId Examples: /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate

header Parameters

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-Org-Ids	string 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. If the header is not set, the operation is performed in scope of the user's accessible orgs.
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: `items` > `taxItems` `items` > `taxationItems` `items` > `comment` `items` > `description`

Responses

200

get/v1/debitmemos/{debitMemoKey}/items

Request samples

cURL

Response samples

application/json

{"items": [{"amount": 1,
"amountWithoutTax": 1,
"appliedToItemId": "402890555a7d4022015a2dadb3b700a6",
"balance": 1,
"beAppliedAmount": 0,
"comment": "This is comment!",
"createdById": "402881e522cf4f9b0122cf5d82860002",
"createdDate": "2017-03-01 17:13:15",
"excludeItemBillingFromRevenueAccounting": true,
"financeInformation": {"deferredRevenueAccountingCode": "Subscription Revenue",
"deferredRevenueAccountingCodeType": "SalesRevenue",
"recognizedRevenueAccountingCode": "Subscription Revenue",
"recognizedRevenueAccountingCodeType": "SalesRevenue"
},
"id": "402890555a87d7f5015a89251ede0046",
"processingType": "Charge",
"quantity": 1,
"serviceEndDate": "2017-11-30",
"serviceStartDate": "2017-11-01",
"sku": "SKU-00000002",
"skuName": "SKU-30",
"soldToContactId": "402881e522cf4f9b0122cf5d82860003",
"soldToContactSnapshotId": "402881e522cf4f9b0122cf5d82860004",
"sourceItemId": "402890555a7d4022015a7dadb3b700a6",
"sourceItemType": "InvoiceDetail",
"subscriptionId": null,
"taxMode": "TaxExclusive",
"taxationItems": {"data": [{"balance": 0.01,
"creditAmount": 0,
"exemptAmount": 0,
"financeInformation": {"salesTaxPayableAccountingCode": null,
"salesTaxPayableAccountingCodeType": null
},
"id": "402890555a87d7f5015a89251ef10047",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"name": "STATE TAX",
"paymentAmount": 0,
"sourceTaxItemId": "402890555a7d4022015a7dadb39b00a1",
"taxAmount": 0.01,
"taxCode": "ZtaxCode",
"taxCodeDescription": "",
"taxDate": "2017-11-30",
"taxRate": 0.0625,
"taxRateDescription": "This is tax rate description!",
"taxRateType": "Percentage"
}
]
},
"unitOfMeasure": "Each",
"unitPrice": 1,
"updatedById": "402881e522cf4f9b0122cf5d82860002",
"updatedDate": "2017-03-01 17:13:15"
}
],
"success": true
}