- CRUD: Update a refund
Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:
{
"message": "Error - unrecognised fields"
}By default, Zuora ignores unknown fields in the request body.
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.
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.
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 (').
A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. Character limit: 32 V****alues: a valid reason code
The status of the refund. Character limit: 10 Values: automatically generated:
CanceledErrorProcessedProcessing
Specifies whether or not the object has been transferred to an external accounting system. Use this field for integrations with accounting systems such as NetSuite. Character limit: 10 Values: automatically generated:
ProcessingYesErrorIgnore
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Status of the refund's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Date when the refund was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Refund object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/refund/{id}
{ "ReasonCode": "Other" }
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/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "Success": true, "Id": "2c93808457d787030157e03198c84918" }