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!

2020-08-05

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 282, August 2020.

• Payment Methods - Added the gatewayOptions field to the request body of each of the following operations:

  • Create credit card payment method
  • Update credit card payment method

• Actions - Made the following updates:

  • In the request body of the "Amend" action, updated the character limit of the request > AmendOptions> ExternalPaymentOptions > ReferenceId field from 60 to 100.
  • In the request body of the "Subscribe" action, updated the character limit of the subscribes > SubscribeOptions> ExternalPaymentOptions > ReferenceId field from 60 to 100.

• Payment Gateway Reconciliation - In the request body of each of the "Reject payment" and "Reverse payment" operations, updated the character limit of the following fields from 60 to 100:

  • referenceId
  • secondReferenceId

• Payments - Made the following updates:

  • In the request body of each of the following operations, updated the character limit of the referenceId field from 60 to 100:
    • Create payment
    • Update Payment
  • In the request body of each of the following operations, updated the character limit of the ReferenceId field from 60 to 100:
    • CRUD: Create payment
    • CRUD: Update payment
  • In the request body of the "Refund payment" operation, updated the character limit of the following fields from 60 to 100:
    • referenceId
    • secondRefundReferenceId

• Refunds - In the request body of the "Update refund" operation, updated the character limit of the referenceId field from 60 to 100.

• Credit Memos - In the request body of the "Refund credit memo" operation, updated the character limit of the following fields from 60 to 100:

  • referenceId
  • secondRefundReferenceId

• Revenue Schedules - In the request body of each of the following operations, updated the character limit of the referenceId field from 60 to 100:

  • Update revenue schedule basic information
  • Create revenue schedule on subscription charge

• Credit Balance Adjustments - In the request body of the "CRUD: Create CreditBalanceAdjustment" operation, updated the character limit of the ReferenceId field from 60 to 100.

• Invoice Adjustments - In the request body of the "CRUD: Create InvoiceAdjustment" operation, updated the character limit of the ReferenceId field from 60 to 100.

• Taxation Items - Made the following updates:

  • Changed the behavior of the "Update taxation item" operation. You can now update the custom fields of the Taxation Item object for all invoices, credit memos, and debit memos regardless of their status.

    Previously, you could only update the custom fields of the Taxation Item object for invoices, credit memos, and debit memos in Draft status.

  • Changed the behavior of the "CRUD: Update TaxationItem" operation. You can now update the custom fields of the Taxation Item object for all invoices regardless of their status.

    Previously, you could only update the custom fields of the Taxation Item object for invoices in Draft status.

Doc Updates

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

• In the description of the “Perform mass action” operation, added a reference link to the Mass Payment Upload article.
• In the "Query custom object records" operation, added a note to the description of the q query parameter.
• In the description of the "Create an event trigger" operation, made the following updates:
  • Restructured the description.
  • Added the list of tenant level base objects.
  • Noted the availabilities of tenant level event triggers and system notifications.