CRUD: Update a refund

Request

path Parameters

required

string

Object id

query Parameters

rejectUnknownFields

boolean

Default: false

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.

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

ReasonCode	string 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 Values: a valid reason code
Status	string The status of the refund. Character limit: 10 Values: automatically generated: `Canceled` `Error` `Processed` `Processing`
TransferredToAccounting	string 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: `Processing` `Yes` `Error` `Ignore`
IntegrationId__NS	string <= 255 characters ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
IntegrationStatus__NS	string <= 255 characters Status of the refund's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Origin__NS	string <= 255 characters Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
SyncDate__NS	string <= 255 characters Date when the refund was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
SynctoNetSuite__NS	string <= 255 characters Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
property name* additional property	any 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.

Responses

200

401

put/v1/object/refund/{id}

Request samples

Payload
cURL

application/json

{"Id": "2c93808457d787030157e03198c84918",
"Status": "Canceled"
}

Response samples