Note: This operation 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.
Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.
If the amount of a memo item is updated, the tax will be recalculated in the following conditions:
You can update a credit memo only if you have the user permission. See Billing Roles for more information.
Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Authorization | string The value is in the |
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 ( |
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-Org-Ids | string 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. If the header is not set, the operation is performed in scope of the user's accessible orgs. |
autoApplyUponPosting | boolean Whether the credit memo automatically applies to the invoice upon posting. |
comment | string [ 0 .. 255 ] characters Comments about the credit memo. |
effectiveDate | string <date> The date when the credit memo takes effect. |
excludeFromAutoApplyRules | boolean Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to |
Array of objects (items) Container for credit memo items. | |
reasonCode | string A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. |
transferredToAccounting | string Whether the credit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. |
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 credit memo'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 credit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
Transaction__NS | string <= 255 characters Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
property name* additional property | any Custom fields of the Credit Memo object. The name of each custom field has the form |
Internal Server Error
Request Errors
{- "autoApplyUponPosting": false,
- "comment": "new comment",
- "effectiveDate": "2017-04-17",
- "excludeFromAutoApplyRules": false,
- "items": [
- {
- "amount": 1,
- "comment": "This is comment!",
- "id": "402890555b797b57015b7986fc1a001c",
- "quantity": 1,
- "serviceEndDate": "2016-11-30",
- "serviceStartDate": "2016-11-01",
- "skuName": "SKU-1",
- "taxItems": [
- {
- "amount": 0.03,
- "id": "402890555b797b57015b7986fc3c001d",
- "jurisdiction": "CALIFORNIA",
- "locationCode": "06",
- "taxCode": null,
- "taxCodeDescription": "This is tax code description!",
- "taxDate": "2016-11-30",
- "taxExemptAmount": 0,
- "taxName": "STATE TAX1",
- "taxRate": 0.0625,
- "taxRateDescription": "This is tax rate description!",
- "taxRateType": "Percentage"
}
], - "unitOfMeasure": "Test_UOM"
}, - {
- "amount": 2,
- "comment": "This is comment!",
- "id": "402890555b797b57015b7986fc41001e",
- "serviceEndDate": "2016-11-30",
- "serviceStartDate": "2016-11-01",
- "skuName": "SKU-2",
- "taxItems": [
- {
- "amount": 0.06,
- "id": "402890555b797b57015b7986fc4c001f",
- "jurisdiction": "CALIFORNIA",
- "locationCode": "06",
- "taxCode": null,
- "taxCodeDescription": "This is tax code description!",
- "taxDate": "2016-11-30",
- "taxExemptAmount": 0,
- "taxName": "STATE TAX2",
- "taxRate": 0.0625,
- "taxRateDescription": "This is tax rate description!",
- "taxRateType": "Percentage"
}
], - "unitOfMeasure": "Test_UOM"
}
], - "reasonCode": "Correcting invoice error"
}
{- "accountId": "4028905f5a87c0ff015a87d25ae90025",
- "accountNumber": "A00000001",
- "amount": 10.76,
- "appliedAmount": 0,
- "autoApplyUponPosting": false,
- "billToContactId": null,
- "billToContactSnapshotId": null,
- "cancelledById": null,
- "cancelledOn": null,
- "comment": "",
- "createdById": "402881e522cf4f9b0122cf5d82860002",
- "createdDate": "2017-03-02 13:17:51",
- "creditMemoDate": "2017-03-02",
- "currency": "USD",
- "einvoiceErrorCode": null,
- "einvoiceErrorMessage": null,
- "einvoiceFileId": null,
- "einvoiceStatus": null,
- "excludeFromAutoApplyRules": true,
- "id": "4028905f5a890526015a8d73f73d0015",
- "invoiceGroupNumber": "N-0001",
- "latestPDFFileId": "4028905f5a890526015a8d7408730024",
- "number": "CM00000001",
- "postedById": null,
- "postedOn": null,
- "reasonCode": "Correcting invoice error",
- "referredInvoiceId": "4028905f5a87c0ff015a87d3f8f10043",
- "refundAmount": 0,
- "reversed": false,
- "sequenceSetId": null,
- "source": "AdhocFromPrpc",
- "sourceId": null,
- "sourceType": "Standalone",
- "status": "Draft",
- "success": true,
- "targetDate": null,
- "taxAmount": 0.76,
- "taxMessage": null,
- "taxStatus": null,
- "totalTaxExemptAmount": 0,
- "transferredToAccounting": "No",
- "unappliedAmount": 10.76,
- "updatedById": "402881e522cf4f9b0122cf5d82860002",
- "updatedDate": "2017-03-02 13:19:00"
}