Sign in
Object Queries

Retrieve a credit memo

Retrieve the details of a specific Credit Memo object.

get/object-query/credit-memos/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

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-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the credit memo.

createdByIdstring

The unique identifier of the user who created the credit memo.

createdDatestring date-time

The date and time when the credit memo was created.

updatedByIdstring

The unique identifier of the user who last updated the credit memo.

updatedDatestring date-time

The date and time when the credit memo was last updated.

appliedAmountnumber double

The applied amount of the credit memo.

balancenumber

The remaining balance of credit memo.

billToContactIdstring

The ID of the bill-to contact associated with the credit memo.

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

billToContactSnapshotIdstring

The ID of the bill-to contact snapshot associated with the credit memo.

The value of this field is null if the bill rule Preserve snapshot of bill-to and sold-to contacts when billing documents are posted is disabled.

cancelledByIdstring nullable

The ID of the Zuora user who cancelled the credit memo.

cancelledOnstring date-time nullable

The date and time when the credit memo was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstring nullable

Comments about the credit memo.

currencystring nullable

The currency of the credit memo.

Note: By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currency</a>.

discountAmountnumber

The amount of the discount on the credit memo.

einvoiceErrorCodestring

The error code returned when the e-invoice file status is Failed. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceErrorMessagestring

The error message returned when the e-invoice file status is Failed. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceFileIdstring

The ID of the e-invoice file generated for the credit memo.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceStatus'Processing' | 'RetrieveTimeOut' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected'

The status of the e-invoice file generation for the credit memo.

  • If e-invoice file generation succeeds, this field is either Generated or Success, and both the error code and message are empty, and the eInvoiceFileId field stores the ID of the generated e-invoice file.

  • If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes RetrieveTimeOut. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry.

  • If a failure occurs during e-invoice file generation, this field is Failed and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.

  • If e-invoice file generation conditionally succeeds, this field is ConditionalSuccess and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.

  • If the e-invoice file has been approved by the tax authority, this field is ApprovedByAuthority. The next status will be either Success or Rejected.

  • If the e-invoice file has been rejected by the government, this field is Rejected. You cannot resend this e-invoice; you must create a new invoice instead.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

excludeFromAutoApplyRulesboolean

Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.

exchangeRateDatestring date

The date of the exchange rate used. The date is in yyyy-mm-dd format. Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.

autoApplyUponPostingboolean

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

memoDatestring date

The date when the credit memo takes effect, in yyyy-mm-dd format. For example, 2024-01-01.

memoNumberstring

The unique identification number of the credit memo.

postedByIdstring

The ID of the Zuora user who posted the credit memo.

postedOnstring date-time

The date and time when the credit memo was posted, in yyyy-mm-dd hh:mm:ss format.

reasonCodestring

A code identifying the reason for the transaction. The value must be an existing reason code or empty.

refundAmountnumber double

The amount of the refund on the credit memo.

reversedboolean

Whether the credit memo is reversed.

revenueImpacting'Yes' | 'No'

Indicates whether this write off operation impacts the revenue. If revenueImpacting = Yes, the deferred revenue accounting code will be automatically selected from the associated invoice

If revenueImpacting = No, users can select an accounting code such as bad-debt expense accounting code for the write off operation.

sequenceSetIdstring nullable

The ID of the sequence set associated with the credit memo.

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

source'BillRun' | 'API' | 'ApiSubscribe' | 'ApiAmend' | 'AdhocFromPrpc' | 'AdhocFromInvoice'

The source of the credit memo.

Possible values:

  • BillRun: The credit memo is generated by a bill run.
  • API: The credit memo is created by calling the Invoice and collect operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.
  • ApiSubscribe: The credit memo is created by calling the Create subscription and Create account operation.
  • ApiAmend: The credit memo is created by calling the Update subscription operation.
  • AdhocFromPrpc: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the Create a credit memo from a charge operation.
  • AdhocFromInvoice: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the Create credit memo from invoice operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the Reverse invoice operation.
sourceIdstring

The ID of the credit memo source.

If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is null.

sourceType'Subscription' | 'Standalone' | 'Invoice' | 'Order' | 'CreditMemo' | 'Consolidation'

The type of the credit memo source.

status'Draft' | 'Posted' | 'Canceled' | 'Error' | 'PendingForTax' | 'Generating' | 'CancelInProgress'

The status of the credit memo.

targetDatestring date

The target date for the credit memo, in yyyy-mm-dd format. For example, 2024-01-01.

taxAmountnumber double

The amount of taxation.

taxMessagestring nullable

The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.

taxStatus'Complete' | 'Error' | 'UnknownError' | 'DuplicateDoc' | 'InvalidRequest' | 'InvalidResponse' | 'TaxEngineError' | 'ConcurrentModify' | 'InternalServerError' | 'TaxCodeTemplateError' | 'Voided'

The status of tax calculation related to the credit memo.

Note: This field is only applicable to tax calculation by third-party tax engines. Also, the Voided status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side.

shipToContactSnapshotIdstring

The ID of the ship-to contact snapshot associated with the credit memo.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

soldToContactSnapshotIdstring

The ID of the sold-to contact snapshot associated with the credit memo.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

taxAutoCalculationboolean

Whether to automatically calculate taxes in the credit memo.

totalAmountnumber double

The total amount of the credit memo, including taxes.

totalAmountWithoutTaxnumber double

The total amount of the credit memo, excluding taxes.

totalTaxExemptAmountnumber double

The calculated tax amount excluded due to the exemption.

transferredToAccounting'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore'

Whether the credit memo was transferred to an external accounting system. This field is used for integration with accounting systems such as NetSuite.

invoiceIdstring

The ID of a referred invoice.

accountIdstring

The ID of the customer account associated with the credit memo.

Example response

{
  "currency": "USD"
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.