Retrieve a payment part item

Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items.

Request
path Parameters
partid
required
string

The unique ID of a specific payment part. You can get the payment part ID from the response of List all parts of a payment.

itempartid
required
string

The unique ID of a specific payment part item. You can get the payment part item ID from the response of List all payment part items.

paymentKey
required
string

The unique ID or number of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1, or P-00000001.

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 should not 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.

Responses
200
500

Internal Server Error

4XX

Request Errors

get/v1/payments/{paymentKey}/parts/{partid}/itemparts/{itempartid}
Request samples 
Response samples 
application/json
{
  • "amount": 4,
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 11:30:37",
  • "debitMemoItemId": "4028905f5a87c0ff015a87e49e7a0063",
  • "id": "4028905f5a87c0ff015a87eb6bd8008a",
  • "invoiceItemId": null,
  • "success": true,
  • "taxItemId": null,
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 11:30:37"
}