Zuora Documentation

Re: API Changelog

2018-01-17

 

API Updates

 

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

 

  • Invoices - Made the following updates:
    • Added a new operation “Get invoice application parts”.
    • In the "Update invoice" operation, added the autoPay field to the request body and response body.
    • In the "Update invoices" operation, added the autoPay field to the request body.
  • Debit Memos - Added a new operation "Get debit memo application parts".
  • Payment Runs - Made the following updates:
    • In the "Get payment run summary" operation, added the following fields to the response body:
      • numberOfCreditBalanceAdjustments
      • numberOfInvoices
      • numberOfUnprocessedInvoices
      • numberOfCreditMemos
      • numberOfDebitMemos
      • numberOfUnappliedPayments
      • numberOfUnprocessedDebitMemos
    • In the "Get payment run summary" operation, added the following nested fields to the totalValues field in the response body:
      • totalValueOfCreditBalance
      • totalValueOfInvoices
      • totalValueOfUnprocessedInvoices
      • totalValueOfDebitMemos
      • totalValueOfCreditMemos
      • totalValueOfUnappliedPayments
      • totalValueOfUnprocessedDebitMemos
  • Mass Updater - In the "Perform mass action" operation, added a value MPU to the params > actionType field in the request body.

 

Doc Updates

 

  • In the code samples of all operations, replaced the authentication scheme using username and password with OAuth v2.0 using bearer token.
  • Changed the entityId and entityName to Zuora-Entity-Ids in the request headers for forward compatibility.
  • In the Zuora Object Model section, corrected the API name of the Billing Run object to BillRun. Previously, the API name was incorrectly listed as BillingRun.
  • In the "CRUD: Get payment" and "CRUD: Update payment" operations, corrected the valid values of the TransferredToAccounting field in the response body. The value Yes was incorrectly displayed as true.
  • In the "CRUD: Retrieve PaymentMethodSnapshot" operation, corrected the valid values of the ExistingMandate field in the response body. The values Yes and No were incorrectly displayed as true and false.
  • Added the missing /v1/ in the URL path to the following operations:
    • Create payment run
    • Get payment runs
    • Update payment run
    • Get payment run
    • Delete payment run
    • Get payment run summary
  • Removed incorrect code samples for the following operations:
    • Generate an OAuth token
    • Add attachments
    • Perform mass action
    • Post usage
    • CRUD: Create Import
    The Curl samples for these operations are correct.
  • Corrected the request content type and parameters of the following operations:
    • Add attachments
    • Perform mass action
    • Post usage
    The request content type for these operations is multipart/form-data with formData parameters. Previously, the request content type was incorrectly documented as application/json with request body parameters.
  • In the "Post usage" operation, corrected the description and example of the checkImportStatus response field. Previously, the checkImportStatus field was documented as being a full URL, including the hostname.
  • Changed the Error reference object name to ActionsErrorResponse in the source YAML file.
  • In the "Get payment runs" operation, corrected the items field name to paymentRuns in the response body.
  • In the following operations, updated the descriptions of the autoApplyCreditMemo and autoApplyUnappliedPayment fields in the request body and response body:
    • Create payment run
    • Update payment run
  • In the following operations, updated the descriptions of the autoApplyCreditMemo and autoApplyUnappliedPayment fields in the response body:
    • Get payment runs
    • Get payment runs
    • Get payment run summary
  • In the source YAML file, corrected the operationId property for the following operations:
    • Delete payment run
    • Get payment run summary
  • In the “Introduction” section, added a link to the API feedback form in the Zuora Community.
  • In the “QueryMore” operation, added the missing required queryLocator field in the request code samples.
  • In the "Query" operation, added the missing conf object in the request body.
  • In the “Other Supported Authentication Schemes” section, added a link to the Connections section.
  • Removed the confusing sentence "A call to connections is a required first step before using the Zuora REST API to access data" in the description of the “Establish connection to Zuora REST API service” operation.
  • Corrected the name of the “Create payment method decryption” operation to “Create Apple Pay payment method”.
  • In the "Create subscription" operation, updated the description of the subscribeToRatePlans > chargeOverrides > quantity field in the request body.
  • Moved the "Get breakdown of invoice by order" operation and the "Update subscription custom fields" operation to the Orders section of the API Reference.
  • In the Orders operations, changed the CommonResponse reference object name to CommonResponseType in the source YAML file.
  • In the "Create and activate order" operation, added the missing autoPay nested field to the newAccount field in the request body.
  • For Orders operations and the "Update subscription custom fields" operation, removed the customField__c field from customFields objects. The structure of customFields objects is now correct in the source YAML file, and the description of customFields objects now explains the correct structure. Also in the source YAML file, changed the name of the corresponding reference object from CustomFields to ObjectCustomFields.