Happy Business Starts Here

Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-08-01

 

Doc Updates

 

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

 

  • Added the missing Zuora-Entity-Ids request header in the following operations:

    • Get revenue recognition rule by product rate plan charge
    • Create revenue schedule for credit memo item (manual distribution)
    • Get revenue schedule by credit memo item ID
    • Create revenue schedule for credit memo item (distribute by date range)
    • Create revenue schedule for debit memo item (manual distribution)
    • Get revenue schedule by debit memo item ID
    • Create revenue schedule for debit memo item (distribute by date range)
    • Get all revenue schedules of product charge by charge ID and billing account ID
  • In the request body of the “Create stored credential profile” operation, added the missing networkTransactionId field.

  • In the request body of the "CRUD: Update account" operation, corrected the descriptions of the following fields:

    • Currency
    • Status
  • In the response body of the "CRUD: Get account" operation, corrected the descriptions of the Status field.

  • In the request body of the "CRUD: Create account" operation, corrected the descriptions of the Status field.

  • In the Zuora Object Model section, added more information about the differnces between the BillingRun object and BillRun object.

  • In the response body of the "CRUD: Get payment method" operation, updated the description of the Active and PaymentMethodStatus fields to distinguish them.

  • In the request body of the "CRUD: Update payment method" operation, updated the description of the PaymentMethodStatus field for better clarity.

Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-08-08

 

API Updates

 

This section lists operations and fields that were added, changed, or removed.

 

The following API updates are available as of Zuora Release 253, July 2019.

 

  • Workflows - Added a new resource called “Workflows”, with the “Get workflows” operation for retrieving workflows on a tenant. Filters can be used to retrieve specific workflows. If no filters are specified, all workflows will be returned.

 

Doc Updates

 

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

 

  • Added more information about the REST endpoint base UL of the US Production Copy Environment.
  • In the "Create payment method" operation, corrected the names of the following fields:

    • bankAccountName
    • bankAccountNumber
    • bankAccountType
    • bankName

    Previously, they were incorrectly documented as:

    • achBankAccountName
    • achBankAccountNumber
    • achBankAccountType
    • achBankName
Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-08-15

 

Doc Updates

 

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

 

  • In the "Amend" action, added the following missing fields to the requests > Amendments field in the request body:

    • ResumeDate
    • SuspendDate
Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-08-28

 

API Updates

 

This section lists operations and fields that were added, changed, or removed.

 

The following API updates are available as of Zuora Billing Release 255, August 2019.

  • Credit Memos - Made the following updates:

    • In the response body of the following operations, added the taxStatus and taxMessage fields:
      • Create credit memo from charge
      • Get credit memo
      • Update credit memo
      • Apply credit memo
      • Unapply credit memo
      • Cancel credit memo
      • Post credit memo
      • Unpost credit memo
    • In the response body of the "Get credit memos" operation, added the following fields to the creditmemos field:
      • taxStatus
      • taxMessage
  • Debit Memos - Made the following updates:

    • In the request body of the "Create debit memo from charge" operation:
      • Added the accountNumber field.
      • Changed the behavior of accountId field. This field is now conditionally required. You must specify accountNumber, accountId, or both in the request body.
    • In the response body of the following operations, added the taxStatus and taxMessage fields:
      • Create debit memo from charge
      • Get debit memo
      • Update debit memo
      • Cancel debit memo
      • Post debit memo
      • Unpost debit memo
    • In the response body of the "Get debit memos" operation, added the following fields to the debitmemos field:
      • taxStatus
      • taxMessage
  • Invoices - In the response body of the following operations, added the taxStatus and taxMessage fields:

    • Create credit memo from invoice
    • Create debit memo from invoice

 

Doc Updates

 

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

  • In the request body of the following operations, added the missing ProductRatePlanChargeTierData field and its nested fields:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • In the request sample of the following operations, removed the ProductRatePlanChargeTierData > ProductRatePlanChargeTier > Active field:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • Added the missing “CRUD: Update ProductRatePlanChargeTier” operation.

  • In the “Get credit card payment methods for account” operation, updated the description to clarify that the response does not include effective details for ACH payment methods if this operation is used to get ACH payment methods.

Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-09-11

 

API Updates

 

This section lists operations and fields that were added, changed, or removed.

 

The following API updates are available as of Zuora Billing Release 256, September 2019.

 

  • Data Queries - In the request body of the "Submit data query" operation, made the following updates:
    • Added TSV and DSV to the enum values of the outputFormat field.
    • Added the columnSeparator field. Use this field to pass in your custom delimiter when you set the outputFormat field to DSV.

 

Doc Updates

 

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

 

  • In the 200 response body of the "Submit data query" operation, added descriptions for the enum values of the data > queryStatus field.

  • Added the missing "CRUD: Update rate plan charge" operation.

  • In the "CRUD: Update invoice" operation, corrected the request example.