Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Credit Memos API

Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice.For more information about credit memos, see Credit and debit memos.

Zuora Credit Memos API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credit Memos. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 22 paths, and defines 58 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

26 operations 22 paths 58 schemas 1 DELETE7 GET8 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 26

Across 22 paths, the API surfaces 26 operations — 1 DELETE, 7 GET, 8 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Credit Memos 26

Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that…

POST
/v1/creditmemos
Create a credit memo from a charge
POST_CreditMemoFromPrpc 9 params → 200
GET
/v1/creditmemos
List credit memos
GET_CreditMemos 30 params → 200
POST
/v1/creditmemos/bulk
Create credit memos
POST_CreateCreditMemos 9 params → 200
PUT
/v1/creditmemos/bulk
Update credit memos
PUT_UpdateCreditMemos 8 params → 200
POST
/v1/invoices/{invoiceKey}/creditmemos
Create a credit memo from an invoice
POST_CreditMemoFromInvoice 10 params → 200
GET
/v1/creditmemos/{creditMemoKey}
Retrieve a credit memo
GET_CreditMemo 7 params → 200
PUT
/v1/creditmemos/{creditMemoKey}
Update a credit memo
PUT_UpdateCreditMemo 8 params → 200
DELETE
/v1/creditmemos/{creditMemoKey}
Delete a credit memo
DELETE_CreditMemo 7 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/apply
Apply a credit memo
PUT_ApplyCreditMemo 8 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/cancel
Cancel a credit memo
PUT_CancelCreditMemo 7 params → 200
POST
/v1/creditmemos/{creditMemoKey}/emails
Email a credit memo
POST_EmailCreditMemo 9 params → 200
POST
/v1/creditmemos/{creditMemoKey}/files
Upload a file for a credit memo
POST_UploadFileForCreditMemo 9 params → 200
GET
/v1/creditmemos/{creditMemoKey}/items
List credit memo items
GET_CreditMemoItems 25 params → 200
GET
/v1/creditmemos/{creditMemoKey}/items/{cmitemid}
Retrieve a credit memo item
GET_CreditMemoItem 9 params → 200
GET
/v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items
List all taxation items of a credit memo item
GET_TaxationItemsOfCreditMemoItem 10 params → 200
GET
/v1/creditmemos/{creditMemoKey}/parts
List all parts of a credit memo
GET_CreditMemoParts 9 params → 200
GET
/v1/creditmemos/{creditMemoKey}/parts/{partid}
Retrieve a credit memo part
GET_CreditMemoPart 8 params → 200
POST
/v1/creditmemos/{creditMemoKey}/pdfs
Generate a credit memo PDF file
POST_CreditMemoPDF 8 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/post
Post a credit memo
PUT_PostCreditMemo 7 params → 200
POST
/v1/creditmemos/{creditMemoKey}/refunds
Refund a credit memo
POST_RefundCreditMemo 9 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/reverse
Reverse a credit memo
PUT_ReverseCreditMemo 8 params → 200
POST
/v1/creditmemos/{creditMemoKey}/taxationitems
Create taxation items for a credit memo
POST_CM_TaxationItems 9 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/unapply
Unapply a credit memo
PUT_UnapplyCreditMemo 8 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/unpost
Unpost a credit memo
PUT_UnpostCreditMemo 7 params → 200
PUT
/v1/creditmemos/{creditMemoId}/write-off
Write off a credit memo
PUT_WriteOffCreditMemo 8 params → 200
PUT
/v1/creditmemos/{creditMemoKey}/einvoice/generate
Generate an e-invoice file for a credit memo
PUT_GenerateEInvoiceFileForCreditMemo 7 params → 200

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are CreditMemoTaxItemFromInvoiceTaxItemType (13 properties), GETCreditMemoPartType (10 properties), GETCreditMemoPartTypewithSuccess (8 properties), CreditMemoUnapplyDebitMemoItemRequestType (5 properties). Each schema is shown below with its type and property counts.

CreditMemoApplyInvoiceItemRequestType
object
5 properties 1 required
PUTCreditMemosWithIdType
CreditMemoApplyDebitMemoItemRequestType
object
5 properties 1 required
PutReverseCreditMemoType
object
2 properties
CreditMemoUnapplyInvoiceRequestType
object
3 properties 2 required
GETCreditMemoType
PostCreditMemoEmailRequestType
object
4 properties
POSTUploadFileResponse
object
2 properties
CommonResponseType
object
3 properties
GETCreditMemoCollectionType
object
3 properties
PostNonRefRefundType
CreditMemoObjectCustomFields
object
Container for custom fields of a Credit Memo object.
RefundObjectNSFields
object
Container for Refund fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
CreditMemoItemObjectCustomFields
object
Container for custom fields of a Credit Memo Item object.
GETCreditMemoPartsCollectionType
object
3 properties
GETCreditMemoTypewithSuccess
CreditMemoUnapplyDebitMemoItemRequestType
object
5 properties 1 required
GETCreditMemoPartType
object
10 properties
DebitMemoObjectCustomFieldsCMWriteOff
object
Container for custom fields of a Debit Memo object.
CreditMemoFromChargeCustomRatesType
CreditMemoUnapplyInvoiceItemRequestType
object
5 properties 1 required
GETCreditMemoItemsListType
object
3 properties
PUTCreditMemoType
POSTTaxationItemForCMType
GETCreditMemoItemTypewithSuccess
GETTaxationItemsOfCreditMemoItemType
PUTBulkCreditMemosRequestType
GETRefundCreditMemoType
CreditMemoUnapplyDebitMemoRequestType
object
3 properties 2 required
PUTCreditMemoWriteOff
PutReverseCreditMemoResponseType
object
3 properties
CreditMemoItemFromInvoiceItemType
PUTCreditMemoWriteOffResponseType
object
2 properties
GETCMTaxItemType
RefundObjectCustomFields
object
Container for custom fields of a Refund object.
CreditMemoFromInvoiceType
UnapplyCreditMemoType
object
3 properties
GETCreditMemoPartTypewithSuccess
object
8 properties
GETTaxationItemListType
object
2 properties
GETCMTaxItemTypeNew
CreditMemoFromChargeType
CreditMemoObjectNSFields
object
Container for Credit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
CreditMemoApplyDebitMemoRequestType
object
3 properties 2 required
RefundCreditMemoItemType
object
3 properties 1 required
CreditMemoFromChargeDetailType
CreditMemoApplyInvoiceRequestType
object
3 properties 2 required
GETTaxationItemTypewithSuccess
BulkCreditMemosResponseType
CreditMemoTaxItemFromInvoiceTaxItemType
object
13 properties
POSTBulkCreditMemosRequestType
object
1 property 1 required
PutCreditMemoTaxItemType
ApplyCreditMemoType
object
3 properties
POSTTaxationItemListForCMType
object
1 property
CreditTaxationItemObjectCustomFields
object
Container for custom fields of a Credit Taxation Item object.
GETCreditMemoItemType
TaxationItemObjectCustomFields
object
Container for custom fields of a Taxation Item object.
POSTMemoPdfResponse
object
1 property
PUTCreditMemoItemType

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-credit-memos-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API