Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-07-26

 

API Updates

 

This section lists operations and fields that were added, changed, or removed.

 

The following API updates are available as of Zuora Release 252, July 2019.

 

  • Credit Memos - Changed the behavior of the "Apply credit memo" operation. You can now use this operation to perform the following operations:

    • Apply negative credit memo items to negative invoice items or debit memo items.
    • Apply negative credit memo items to the taxation items of negative invoice items or debit memo items.
    • Apply the taxation items of negative credit memo items to negative invoice items or debit memo items.
    • Apply the taxation items of negative credit memo items to those of negative invoice items or debit memo items.
  • Debit Memos - Changed the behavior of the "Create debit memo from charge" operation. You can now use this operation to create negative debit memo items from negative product rate plan charges.

  • Invoices - Changed the behavior of the "Create debit memo from invoice" operation. You can now use this operation to create negative debit memo items from negative invoice items.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the "Create payment method" operation, made the following updates:

    • Added the following missing fields to the request body:

      • bankABACode
      • achBankAccountName
      • achBankAccountNumber
      • achBankAccountType
      • achBankName
      • addressLine1
      • addressLine2
      • phone
      • city
      • country
      • state
      • zipCode
    • Clarified that these fields are applicable to ACH payment methods.

  • In the "Get revenue schedule by invoice item adjustment" operation, corrected the description of the invoice-item-adj-key path parameter.

  • In the code sample of the request body for the following operations:

    • Create revenue schedule for credit memo item (distribute by date range)
    • Create revenue schedule for debit memo item (distribute by date range)

    Made the following updates:

    • Removed the redundant top-level application/json field.
    • Corrected the eventType and eventTypeSystemId field to avoid confusion.
  • In the request body of the following operations, corrected the data type of the billingCycleDay field to string:

    • Create payment run
    • Update payment run
  • In the response body of the "Get payment run" operation, corrected the data type of the billingCycleDay field to string.