Create a credit memo from an invoice

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.

Creates an ad-hoc credit memo from an invoice.

You can create a credit memo from an invoice only if you have the user permission. See Billing Roles for more information.

For a use case of this operation, see Create credit memo.

Zero-amount memo items are supported in the following scenarios:

  • If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.
  • If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.
Request
path Parameters
invoiceKey
required
string

The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.

header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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

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.

zuora-version
string

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following request fields:

  • items > comment
  • items > description
Request Body schema: application/json
required
autoApplyToInvoiceUponPosting
boolean

Whether the credit memo automatically applies to the invoice upon posting.

autoPost
boolean
Default: false

Whether to automatically post the credit memo after it is created. Setting this field to true, you do not need to separately call the Post credit memo operation to post the credit memo.

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 credit memos to invoices.

invoiceId
string

The ID of the invoice that the credit memo is created from.

  • If this field is specified, its value must be the same as the value of the invoiceId path parameter. Otherwise, its value overrides the value of the invoiceId path parameter.
  • If this field is not specified, the value of the invoiceId path parameter is used.
Array of objects (items) <= 1000 items

Container for items. The maximum number of items is 1,000.

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.

taxAutoCalculation
boolean
Default: true

Whether to automatically calculate taxes in the credit memo.

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 customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
post/v1/invoices/{invoiceKey}/creditmemos
Request samples
application/json
{
  • "autoApplyToInvoiceUponPosting": false,
  • "autoPost": false,
  • "comment": "the comment",
  • "effectiveDate": "2016-11-30",
  • "excludeFromAutoApplyRules": false,
  • "items": [
    ],
  • "reasonCode": "Write-off"
}
Response samples
application/json
{
  • "accountId": "402890555a7d4022015a7dabf5f60088",
  • "accountNumber": "A00000001",
  • "amount": 0.01,
  • "appliedAmount": 0,
  • "autoApplyUponPosting": false,
  • "billToContactId": null,
  • "billToContactSnapshotId": null,
  • "cancelledById": null,
  • "cancelledOn": null,
  • "comment": "the comment",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 15:19:42",
  • "creditMemoDate": "2017-11-30",
  • "currency": "USD",
  • "einvoiceErrorCode": null,
  • "einvoiceErrorMessage": null,
  • "einvoiceFileId": null,
  • "einvoiceStatus": null,
  • "excludeFromAutoApplyRules": false,
  • "excludeItemBillingFromRevenueAccounting": true,
  • "id": "402890555a87d7f5015a88bd27f80014",
  • "invoiceGroupNumber": "N-0001",
  • "latestPDFFileId": null,
  • "number": "CM00000013",
  • "postedById": null,
  • "postedOn": null,
  • "reasonCode": "Write-off",
  • "referredInvoiceId": "402890555a7d4022015a7dadb3b300a4",
  • "refundAmount": 0,
  • "reversed": false,
  • "sequenceSetId": null,
  • "source": "AdhocFromInvoice",
  • "sourceId": null,
  • "sourceType": "Invoice",
  • "status": "Draft",
  • "success": true,
  • "targetDate": null,
  • "taxAmount": 0.01,
  • "taxMessage": null,
  • "taxStatus": null,
  • "totalTaxExemptAmount": 0,
  • "transferredToAccounting": "No",
  • "unappliedAmount": 0.01,
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 15:19:42"
}