Zuora Documentation

Re: API Changelog

 

2018-03-21

 

API Updates

 

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

 

  • Added the Event Triggers and Notification sections.

 

Doc Updates

 

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

 

  • Removed the Notification History section. The operations previously in this section are now in the Notification section.

 

2018-03-16

 

API Updates

 

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

 

  • Orders - Made the following updates:
    • In the “Preview order” operation, added a new orderItems field and its nested fields to the previewResult > orderMetrics > orderActions field in the response body.
    • In the “Preview order” operation, added a new elp field and its nested fields to the previewResult > orderMetrics > orderActions > orderMetrics field in the response body.
    • In the “Preview order” operation, added new orderItemId and generatedReason fields to the previewResult > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) field in the response body.
    • In the following operations, added a new orderItems field and its nested fields to the orders > subscriptions > orderActions field in the response body:
      • Get all orders

      • Get orders by subscription owner

      • Get orders by subscription number

      • Get orders by invoice owner

    • In the following operations, added a new elp field and its nested fields to the orders > subscriptions > orderActions > orderMetrics field in the response body:

      • Get all orders

      • Get orders by subscription owner

      • Get orders by subscription number

      • Get orders by invoice owner

    • In the following operations, added new orderItemId and generatedReason fields to the orders > subscriptions > orderActions > orderMetrics > mrr (and quantity, tcb, tcv) field in the response body:

      • Get all orders

      • Get orders by subscription owner

      • Get orders by subscription number

      • Get orders by invoice owner

    • In the “Get an order” operation, added a new orderItems field and its nested fields to the order > subscriptions > orderActions field in the response body.

    • In the “Get an order” operation, added a new elp field and its nested fields to the order > subscriptions > orderActions > orderMetrics field in the response body.

    • In the “Get an order” operation, added new orderItemId and generatedReason fields to the order > subscriptions > orderActions > orderMetrics > mrr (and quantity, tcb, tcv) field in the response body.

    • In the “Get breakdown of invoice by order” operation, added the following new fields to the breakdowns > breakdownDetails field in the response body:

      • orderItemId
      • orderActionId
      • startDate
      • endDate
      • generatedReason
  • Credit Memos - Made the following updates:
    • In the “Get breakdown of credit memo by order” operation, added the following nested fields to the breakdowns > breakdownDetails field in the response body:
      • orderItemId
      • orderActionId
      • startDate
      • endDate
      • generatedReason
    • In the “Create credit memo from charge” operation, added the customField__c nested field to the items field in the request body.
  • Debit Memos - In the “Create credit memo from charge” operation, added the customField__c nested field to the items field in the request body.
  • Invoices - In the following operations, added the customField__c nested field to the items field in the request body. This has been documented in the v2018-02-07 API changelog.
    • Create credit memo from invoice
    • Create debit memo from invoice
  • Describe - In the “Describe object” operation, added the response code 404 and the corresponding description. Previously, it returned 500 if the requested object did not exist and was not documented.

 

Doc Updates

 

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

 

  • In the “Preview order” operation, added the missing subscriptionOwner and invoiceOwner fields to the previewResult > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) response field.

  • In the following operations, added the missing createdDate, createdBy, updatedDate, and updatedBy fields to the orders field in the response body:

    • Get all orders

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

  • In the following operations, added the missing customFields field to the orders > subscriptions field in the response body:

    • Get all orders

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

  • In the following operations, added the missing subscriptionOwner and invoiceOwner fields to the orders > subscriptions > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) fields in the response body:

    • Get all orders

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

  • In the “Get an order” operation, added the missing createdDate, createdBy, updatedDate, and updatedBy fields to the order field in the response body.

  • In the “Get an order” operation, added the missing customFields field to the order > subscriptions field in the response body.

  • In the “Get an order” operation, added the missing subscriptionOwner and invoiceOwner fields to the order > subscriptions > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) fields in the response body.

  • In the “Create and activate order” operation, updated the description of the existingAccountNumber and accountNumber fields to clarify these fields specify the invoice owner of the subscriptions in the order

  • Updated the JSON response samples in the following operations:

    • Preview order

    • Get all orders

    • Get an order

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

    • Get breakdown of invoice by order

  • Corrected links to Order Metrics documentation.

  • Added the Order ELP and Order Item objects to the listing of API names in the Zuora Object Model section.

  • In the YAML source for the “Get order metrics for evergreen subscription” operation, renamed the following reference objects:

    • GetOrderResponse

    • Order

    • OrderAction

    • OrderMetrics

    • TimeSlicedMetrics

    • TimeSlicedNetMetrics

    • TimeSlicedTcbNetMetrics

    The names of the reference objects now end with “ForEvergreen”. For instance, GetOrderResponseForEvergreen, and so on.

  • Removed the “Custom Fields” and “Usage (with Real-Time Rating)” sections.
  • In the following operations, added detailed descriptions to each value of the source field and updated the sourceId field description in the response body:
    • Create credit memo from charge
    • Create credit memo from invoice
    • Get credit memo
    • Get credit memos
    • Update credit memo
    • Apply credit memo
    • Unapply credit memo
    • Cancel credit memo
    • Post credit memo
    • Query credit memos by account
  • In the description of the ratingGroup field in the request body of the following operations, noted that the ByGroupId value is only available if you have Real-Time Usage Rating feature enabled:
    • Create account: subscriptions > subscribeToRatePlans > chargeOverrides > ratingGroup
    • Create subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
    • Preview subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
    • Update subscription: add > chargeOverrides > ratingGroup
  • In the description of the ratingGroup field in the response body of the following operations, noted that the ByGroupId value is only available if you have Real-Time Usage Rating feature enabled:
    • Get subscriptions by account: subscriptions > ratePlans > ratePlanCharges > ratingGroup
    • Get subscriptions by key: ratePlans > ratePlanCharges > ratingGroup
    • Get subscriptions by key and version: ratePlans > ratePlanCharges > ratingGroup
    • Get product catalog: products > productRatePlans > productRatePlanCharges > ratingGroup
  • In the “Get account summary” operation, updated the description of the usage field in the response body.
  • In the “CRUD: Create Payment Method” operation, added the missing CreditCardNumber and CreditCardSecurityCode fields in the request body.
  • In the description of the “itempartid” parameter of the “Get payment part item” operation, corrected the “Get payment part items” operation link from https://www.zuora.com/developer/api-reference/#operation/GET_PayemntItemParts to https://www.zuora.com/developer/api-reference/#operation/GET_PaymentItemParts.
  • In the “Get revenue schedule by invoice item adjustment” operation, changed the endpoint parameter “{invoice-item-adj-id}” to “{invoice-item-adj-key}” to be more accurate and in line with the OpenAPI 2.0 specification.
  • In the Endpoint section, added a note that you need to contact Zuora Global Support to enable REST API in Services environments.
  • In the "Query" operation, corrected the type of the batchSize field from “Integer” to “integer”.