List attachments by object type and key

GET

/v1/attachments/:object-type/:object-key

GET

/v1/attachments/:object-type/:object-key

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.attachments.get_attachments_list(
    object_type="account",
    object_key="object-key",
)

{
  "attachments": [
    {
      "createdBy": "402881e522cf4f9b0122cf5d82860002",
      "createdOn": "2016-03-21 14:00:47",
      "fileContentType": "application/pdf",
      "fileId": "402896b95397c169015397c2ebc50002",
      "fileName": "Search _ Splunk.pdf",
      "id": "402896b95397c169015397c2ebca0003",
      "updatedBy": "402881e522cf4f9b0122cf5d82860002",
      "updatedOn": "2016-03-21 14:00:47",
      "success": true
    },
    {
      "createdBy": "4028e487327fd45a0132829ebb673ff9",
      "createdOn": "2016-05-02 13:09:17",
      "description": "",
      "fileContentType": "text/plain",
      "fileId": "8a8083e1545b706a01547316d9094400",
      "fileName": "AttachTest.txt",
      "id": "8a8083e1545b706a01547316d93f4401",
      "updatedBy": "4028e487327fd45a0132829ebb673ff9",
      "updatedOn": "2016-05-02 13:09:17"
    }
  ],
  "success": true
}

Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo.

You can only use this operation if you have a Billing role that includes the Manage Attachments permission. For more information, see Billing roles. To change your Billing role, contact your Zuora platform administrator.

Note: The Credit and Debit Memos feature 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.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

object-typeenumRequired

The type of the object to list attachements for.

Allowed values:

object-keystringRequired

ID of the object to list attachements for.

If object-type is account, specify an account ID or number.
If object-type is invoice, specify an invoice ID.
If object-type is subscription, specify a subscription number.
If object-type is creditmemo, specify a credit memo ID or number.
If object-type is debitmemo, specify a debit memo ID or number.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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

Query parameters

pageintegerOptional>=1Defaults to 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.

pageSizeintegerOptional<=40Defaults to 20

The number of records returned per page in the response.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

attachmentslist of objectsOptional

Container for one or more attachments.

nextPagestringOptionalformat: "URL"

URL to retrieve the next page of the response if it exists; otherwise absent.

successbooleanOptional

Returns true if the request was processed successfully.

Errors

4XX

Client Request Error

500

Internal Server Error