Payments

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.

get/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}
  • Auth: HTTP bearer

Path parameters

partidstring required

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.

itempartidstring required

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.

paymentKeystring required

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

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 payment part item.

createdByIdstring

The ID of the Zuora user who created the payment part item.

createdDatestring

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

debitMemoItemIdstring

The ID of the debit memo item associated with the payment part item.

idstring

The ID of the payment part item.

invoiceItemIdstring nullable

The ID of the invoice item associated with the payment part item.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

successboolean

Returns true if the request was processed successfully.

taxItemIdstring nullable

The ID of the taxation item associated with the payment part item.

updatedByIdstring

The ID of the Zuora user who last updated the payment part item.

updatedDatestring

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

Changes

No operation changes recorded.