Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.

 

For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!

 

2019-02-27

 

API Updates

 

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 239, February 2019.

 

  • Accounts - In the request body of the “Create account” operation, changed the behavior of the runBilling field to match the documentation.

    Previously, invoices were also generated even if runBilling is set to false. Credit memos were also generated if the Invoice Settlement feature was enabled.

 

2019-02-20

 

API Updates

 

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 239, February 2019.

 

  • Payments - In the request body of the “Update payment” operation, added the referenceId field.

  • OAuth - In the “Generate an OAuth token” operation, the client_secret request body field now has a maximum supported length of 42 characters.

    When you create an OAuth client using the Zuora UI, the Client Secret is 38 to 42 characters long. Previously, Client Secrets were always 20 characters long. You can continue to use existing Client Secrets without modification.

 

The following items are API updates specific to enhancements to the Invoice Item Settlement feature:

 

  • Invoices - Made the following updates:

    • Added a new operation “Get taxation items of invoice item”.
    • In the response body of the “Get invoice items” operation, added the balance and taxationItems nested fields to the invoiceItems field.
  • Credit Memos - Made the following updates:

    • Added a new operation “Get taxation items of debit memo item”.
    • In the “Get credit memo items” operation:
      • Added the zuora-version request header.
      • Added the taxationItems nested fields to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
      • Changed the behavior of the items > creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.
    • In the “Get credit memo item” operation:
      • Added the zuora-version request header.
      • Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
      • Changed the behavior of the creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.
  • Debit Memos - Made the following updates:

    • Added a new operation called “Get taxation items of debit memo item”.
    • In the “Get debit memo items” operation:
      • Added the zuora-version request header.
      • Added the taxationItems nested field to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
      • Changed the behavior of the items > taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.
    • In the “Get debit memo item” operation:
      • Added the zuora-version request header.
      • Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later.
      • Changed the behavior of the taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.

 

Doc Updates

 

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

 

  • In the “Subscribe” action, made the following updates:

    • Added the AccountId nested field to the subscribes > Account request body field.
    • Removed the following nested fields from the subscribes > Account request body field:
      • Balance
      • BillToId
      • CreatedById
      • CreatedDate
      • CreditBalance
      • SoldToId
      • Status
      • UpdatedById
      • UpdatedDate
    • Improved the request and response samples.
  • In the “Generate an OAuth token” operation, documented the supported length of the client_id request body field.

  • In the “API Versions” section, added the following fields to the “Minor Version History” table:

    • creditTaxItems
    • taxItems
    • taxationItems
  • In the request body of the “Generate RSA signature” operation, removed the redundant “zuora.com/apps/PublicHostedPageLite.do if you are on the API Sandbox environment.” from the description of the uri field.