Update document properties

Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Updates document properties with a specific ID for a billing document. Billing documents include invoices, credit memos, and debit memos.

Note: You can update document properties for credit and debit memos only if you have the Invoice Settlement feature 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.

Request
path Parameters
documentPropertiesId
required
string

The unique ID of document properties to be updated. For example, 402892c74c9193cd014c96bbe7c101f9.

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-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-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 (').

Request Body schema: application/json
required
customFileName
string

The custom file name to use to generate new Word or PDF files for the billing document.

Responses
200
put/v1/document-properties/{documentPropertiesId}
Request samples
application/json
{
  • "customFileName": "exampleCreditMemo"
}
Response samples
application/json
{
  • "success": true,
  • "id": "402892c74c9193cd014c96bbe7c101f9",
  • "documentId": "40288af1614cee0b01614cf2ec25000a",
  • "documentType": "CreditMemo",
  • "customFileName": "customPDFName"
}