POST /v1/creditmemos/{creditMemoKey}/taxationitems

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 taxation items for a credit memo.

Servers

Path parameters

Name Type Required Description
creditMemoKey String Yes

The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Content-Encoding String No

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.

Zuora-Track-Id String No

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

Authorization String No

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Idempotency-Key String No

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.

Zuora-Entity-Ids String No

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 No

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.

Accept-Encoding String No

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.

Request body fields

Name Type Required Description
taxationItems[] Array No

Container for taxation items.

taxationItems[].memoItemId String No

The ID of the credit memo that the taxation item is created for.

taxationItems[].taxAmount Number Yes

The amount of the tax applied to the credit memo.

taxationItems[].locationCode String No

The identifier for the location based on the value of the taxCode field.

taxationItems[].sourceTaxItemId String No

The ID of the taxation item of the invoice, which the credit memo is created from.

If you want to use this REST API to create taxation items for a credit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call.

Note:

  • This field is only used if the credit memo is created from an invoice.
  • If you do not contain this field in the request body, Zuora will automatically set a value for the sourceTaxItemId field based on the tax location code, tax jurisdiction, and tax rate.
taxationItems[].taxCodeDescription String No

The description of the tax code.

taxationItems[].financeInformation Object No

Container for the finance information related to the taxation item.

taxationItems[].financeInformation.salesTaxPayableAccountingCode String No

The accounting code for the sales taxes payable.

taxationItems[].financeInformation.onAccountAccountingCode String No

The accounting code that maps to an on account in your accounting system.

taxationItems[].exemptAmount Number No

The calculated tax amount excluded due to the exemption.

taxationItems[].jurisdiction String Yes

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

taxationItems[].name String Yes

The name of the taxation item.

taxationItems[].taxRateType String Yes

The type of the tax rate applied to the credit memo.

Possible values:

  • "FlatFee"
  • "Percentage"
taxationItems[].taxCode String No

The tax code identifies which tax rules and tax rates to apply to a specific credit memo.

taxationItems[].taxDate String No

The date when the tax is applied to the credit memo.

taxationItems[].taxRate Number Yes

The tax rate applied to the credit memo.

taxationItems[].taxRateDescription String No

The description of the tax rate.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.