Zuora Documentation

Re: API Changelog

2018-02-07

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the February 2018 release, R221.

 

  • Credit Memos - Made the following updates:
    • In the “Create taxation items for credit memo” operation, added the customField__c nested field to the taxationItems field in the request body and response body.
    • In the “Update credit memo” operation, added the customField__c nested field to the items field in the request body.
    • In the “Get credit memo items” operation, added the customField__c nested field to the items field in the response body.
    • In the “Get credit memo item” operation, added the customField__c field to the response body.
  • Debit Memos - Made the following updates:
    • In the following operations, added the autoPay field to the request body and response body:
      • Create debit memo from charge
      • Update debit memo
    • In the “Get debit memos” operation, added the autoPay nested field to the debitmemos field in the response body.
    • In the following operations, added the autoPay field to the response body:
      • Get debit memo
      • Cancel debit memo
      • Post debit memo
    • In the “Update debit memo” operation, added the autoPay field to the request body and response body, and added the customField__c nested field to the items field in the request body.
    • In the “Create taxation items for debit memo” operations, added the customField__c nested field to the taxationItems field in the request body and response body.
    • In the “Get debit memo items” operation, added the customField__c nested field to the items field in the response body.
    • In the “Get debit memo item” operation, added the customField__c field to the response body.
  • Invoices - Made the following updates:
    • In the “Create debit memo from invoice” operation, added the autoPay field to the request body and response body.
    • In the following operations, added the customField__c nested field to the items field in the request body.
      • Create credit memo from invoice
      • Create debit memo from invoice
  • Taxation Items - Made the following updates:
    • In the “Update taxation item” operation, added the customField__c field to the request body and response body.
    • In the “Get taxation item” operation, added the customField__c field to the response body.
  • Orders - In the "Create and activate order" operation, added the newSubscriptionOwnerAccount field and its nested fields to the Subscriptions > OrderActions > createSubscription field in the request body.

 

Doc Updates

 

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

 

  • Added the missing /v1/ in the URL path of the following operations:
    • CRUD: Retrieve PaymentMethodSnapshot
    • CRUD: Delete PaymentMethodSnapshot
  • Removed the trailing slash from the URL of the "Get revenue schedule by invoice item adjustment" operation.
  • In the “Create Apple Pay payment method” operation, added a note to interpret that when you set the processPayment field to false, you must select the Verify new credit card check box on the gateway instance setting page.
  • In the “Actions” section:
    • Added a note that Actions do not support Advanced AR Settlement feature.
    • Added a description that you can use the X-Zuora-WSDL-Version field in the request header to change the WSDL version.