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! 

 

2018-06-10

 

API Updates

 

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

 

  • Accounts - Made the following updates:

    • Added the creditMemoTemplateId and debitMemoTemplateId fields to the request body of the following operations:
      • Create account
      • Update account
    • Added the creditMemoTemplateId and debitMemoTemplateId fields to the basicInfo field in the response body of the “Get account” operation.
  • Credit Memos - Added the gatewayId field to the request body of the “Refund credit memo” operation.

  • Orders - Added the ProcessingOptions > ApplyCreditBalance field to the request body of the “Create order” operation.

 

Doc Updates

 

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

 

  • In the “Create order” operation, made the following updates :

    • Updated the JSON request and response samples for the following new field added to the request body: ProcessingOptions > ApplyCreditBalance
    • In the request body, corrected the subscriptions > orderActions > updateProduct > chargeUpdates > billing > billingPeriodAlignment field from required to optional.
    • In the description of the following country fields in the request body, clarified that this field is required for the use of the Zuora Tax feature:
      • newAccont> soldToContact > country
      • newAccont> billToContact > country
      • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact > country
      • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact > country
    • In the description of the following billCycleDay fields in the request body, clarified that when this field is set to 0 (zero), the bill cycle day is configured as “AutoSet”:
      • newAccount > billCyleDay
      • subscriptions > orderActions > createSubscriptions > newSubscriptionsOwnerAccount > billCycleDay
    • In the source YAML file, changed the Contact reference object name to BillToContact in the newAccount > billToContact field definition of the request body.
    • In the source YAML file, changed the Contact reference object name to SoldToContact in the newAccount > soldToContact field definition of the request body.
    • In the source YAML file, changed the Contact reference object name to BillToContact in the definition of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact field in the request body.
    • In the source YAML file, changed the Contact reference object name to SoldToContact in the definition of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact field in the request body.
  • In the “Preview order” operation, made the following updates:

    • In the request body, corrected the previewAccountInfo > soldToContact field from required to optional.
    • In the description of the following country fields in the request body, clarified that this field is required for the use of the Zuora Tax feature:
      • previewAccountInfo> soldToContact > country
      • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact > country
      • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact > country
    • In the description of the following billCycleDay fields in the request body, clarified that when this field is set to 0 (zero), the bill cycle day is configured as “AutoSet”:
      • previewAccountInfo > billCyleDay
      • subscriptions > orderActions > createSubscriptions > newSubscriptionsOwnerAccount > billCycleDay
    • In the source YAML file, changed the Contact reference object name to BillToContact in the definition of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact field in the request body.
    • In the source YAML file, changed the Contact reference object name to SoldToContact in the definition of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact field in the request body.
  • In the source YAML file, specified that the zObject reference object has additional properties.

  • In the source YAML file, specified that the zObject_update reference object extends the zObject reference object.

  • Corrected the value of the creditmemos > referredInvoiceId field in the 200 response sample of the “Get credit memos” operation.

  • In the “Subscribe” action, corrected the enum values of the PriceFormat field from Flat Fee to FlatFee and from Per Unit to PerUnit.

  • Added the 200 response sample to the “CRUD: Retrieve Subscription” operation.