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 Debit Memos API

Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo.For more information about debit memos, see Credit and debit memos.

Zuora Debit 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 Debit Memos. The published artifact set on APIs.io includes an OpenAPI specification.

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

22 operations 17 paths 43 schemas 1 DELETE6 GET8 POST7 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 22

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

Debit Memos 22

Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charg…

POST
/v1/debitmemos
Create a debit memo from a charge
POST_DebitMemoFromPrpc 9 params → 200
PUT
/v1/debitmemos
Update due dates for debit memos
PUT_UpdateDebitMemosDueDates 7 params → 200
GET
/v1/debitmemos
List debit memos
GET_DebitMemos 27 params → 200
POST
/v1/debitmemos/bulk
Create debit memos
POST_CreateDebitMemos 9 params → 200
PUT
/v1/debitmemos/bulk
Update debit memos
PUT_UpdateDebitMemos 8 params → 200
POST
/v1/invoices/{invoiceKey}/debitmemos
Create a debit memo from an invoice
POST_DebitMemoFromInvoice 10 params → 200
GET
/v1/debitmemos/{debitMemoKey}
Retrieve a debit memo
GET_DebitMemo 7 params → 200
PUT
/v1/debitmemos/{debitMemoKey}
Update a debit memo
PUT_DebitMemo 8 params → 200
DELETE
/v1/debitmemos/{debitMemoKey}
Delete a debit memo
DELETE_DebitMemo 7 params → 200
GET
/v1/debitmemos/{debitMemoId}/application-parts
List all application parts of a debit memo
GET_DebitMemoApplicationParts 7 params → 200
PUT
/v1/debitmemos/{debitMemoKey}/cancel
Cancel a debit memo
PUT_CancelDebitMemo 7 params → 200
POST
/v1/debitmemos/{debitMemoKey}/collect
Collect a posted debit memo
POST_DebitMemoCollect 9 params → 200
POST
/v1/debitmemos/{debitMemoKey}/emails
Email a debit memo
POST_EmailDebitMemo 9 params → 200
POST
/v1/debitmemos/{debitMemoKey}/files
Upload a file for a debit memo
POST_UploadFileForDebitMemo 9 params → 200
GET
/v1/debitmemos/{debitMemoKey}/items
List debit memo items
GET_DebitMemoItems 24 params → 200
GET
/v1/debitmemos/{debitMemoKey}/items/{dmitemid}
Retrieve a debit memo item
GET_DebitMemoItem 9 params → 200
GET
/v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items
List all taxation items of a debit memo item
GET_TaxationItemsOfDebitMemoItem 10 params → 200
POST
/v1/debitmemos/{debitMemoKey}/pdfs
Generate a debit memo PDF file
POST_DebitMemoPDF 8 params → 200
PUT
/v1/debitmemos/{debitMemoKey}/post
Post a debit memo
PUT_PostDebitMemo 7 params → 200
PUT
/v1/debitmemos/{debitMemoKey}/unpost
Unpost a debit memo
PUT_UnpostDebitMemo 7 params → 200
POST
/v1/debitmemos/{debitMemoKey}/taxationitems
Create taxation items for a debit memo
POST_DM_TaxationItems 9 params → 200
PUT
/v1/debitmemos/{debitMemoKey}/einvoice/generate
Generate an e-invoice file for a debit memo
PUT_GenerateEInvoiceFileForDebitMemo 7 params → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are DebitMemoTaxItemFromInvoiceTaxItemType (13 properties), GetDebitMemoApplicationPartType (7 properties), DebitMemoCollectRequest (4 properties), PostDebitMemoEmailType (4 properties). Each schema is shown below with its type and property counts.

GETDebitMemoItemTypewithSuccess
GetDebitMemoApplicationPartCollectionType
object
3 properties
BulkDebitMemosResponseType
POSTUploadFileResponse
object
2 properties
PutDebitMemoTaxItemType
CommonResponseType
object
3 properties
DebitMemoTaxItemFromInvoiceTaxItemType
object
13 properties
PostDebitMemoEmailType
object
4 properties
DebitMemoCollectResponse
DebitMemoFromInvoiceType
POSTBulkDebitMemosRequestType
object
1 property 1 required
GETDebitMemoItemType
GETDMTaxItemType
GETDebitMemoCollectionType
object
3 properties
DebitMemoObjectCustomFields
object
Container for custom fields of a Debit Memo object.
GETDebitMemoItemCollectionType
object
3 properties
PUTBatchDebitMemosRequest
object
1 property
PUTBulkDebitMemosRequestType
DebitMemoFromChargeType
GETTaxationItemListType
object
2 properties
DebitMemoCollectResponseAppliedCreditMemos
DebitTaxationItemObjectCustomFields
object
Container for custom fields of a Debit Taxation Item object.
DebitMemoObjectNSFields
object
Container for Debit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
3 properties
GETTaxationItemsOfDebitMemoItemType
GETDMTaxItemTypeNew
PUTDebitMemoItemType
GETDebitMemoType
DebitMemoFromChargeDetailType
GETDebitMemoTypewithSuccess
GETTaxationItemTypewithSuccess
BatchDebitMemoType
object
2 properties
DebitMemoFromChargeCustomRatesType
DebitMemoItemObjectCustomFields
object
Container for custom fields of a Debit Memo Item object.
DebitMemoCollectResponseAppliedPayments
POSTTaxationItemForDMType
GetDebitMemoApplicationPartType
object
7 properties
POSTTaxationItemListForDMType
object
1 property
PUTDebitMemoType
DebitMemoItemFromInvoiceItemType
DebitMemoCollectRequest
object
4 properties
PUTDebitMemoWithIdType
TaxationItemObjectCustomFields
object
Container for custom fields of a Taxation Item object.
POSTMemoPdfResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-debit-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