Happy Business Starts Here

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!

 

2019-05-08

 

Doc Updates

 

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

 

  • Added the following operations:

    • CRUD: Create CreditBalanceAdjustment
    • CRUD: Update CreditBalanceAdjustment
  • In the 200 respsonse body of the following operations, added the processId and reasons fields:

    • Update account
    • Activate accounting code
    • Deactivate accounting code
    • Delete accounting code
    • Update an accounting code
    • Close accounting period
    • Set accounting period to pending close
    • Update accounting period
    • Delete accounting period
    • Re-open accounting period
    • Run trial balance
    • Edit attachments
    • Delete attachments
    • Email billing documents generated from bill run
    • Multi-entity: Share a product with an Entity
    • Establish connection to Zuora REST API service
    • Delete credit memo
    • Email credit memo
    • Get breakdown of credit memo by order
    • Request breakdown of credit memo items by order
    • Update debit memos
    • Delete debit memo
    • Email debit memo
    • Delete document properties
    • Update invoices
    • Email invoice
    • Delete journal run
    • Cancel journal run
    • Stop mass action
    • Delete Order
    • Update order custom fields
    • Update subscription custom fields
    • Get an order
    • Get order metrics for evergreen subscription
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get rated result for order
    • Get billing information for order
    • Create order
    • Update order action trigger dates
    • Preview order
    • Get term information for subscription
    • Get breakdown of invoice by order
    • Request breakdown of invoice items by order
    • Delete payment
    • Delete payment method
    • Scrub payment method
    • Create payment method
    • Delete payment run
    • Delete refund
    • Update custom fields on revenue items by revenue event number
    • Update custom fields on revenue items by revenue schedule number
    • Delete revenue schedule
    • Update revenue schedule basic information
    • Delete sequence set
    • Delete summary journal entry
    • Cancel summary journal entry
    • Update basic information of a summary journal entry
    • Delete taxation item
  • In the 200 respsonse body of the “Get job status and response” operation, added the following nested fields to the result field:

    • processId
    • reasons
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!

 

2019-05-20

 

API Updates

 

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

The following API updates are available as of Zuora Release 246, May 2019.

 

  • Contacts - Added a new operation called “Scrub contact”.

  • Credit Memos - Added a new operation called “Upload file for credit memo”.

  • Debit Memos - Added a new operation called “Upload file for debit memo”.

  • Invoices - Made the following updates:

    • Added a new operation called “Upload file for invoice”.
    • In the response body of the “Get invoice items” operation, added the availableToCreditAmount nested field to the invoiceItems field and invoiceItems > taxationItems > data field.
    • In the response body of the “Get taxation items of invoice item” operation, added the availableToCreditAmount nested field to the data field.
  • Accounts - Changed the behavior of the “Generate billing documents by account” operation. You can now generate billing documents for all subscriptions except for cancelled and suspended subscriptions. Previously, you could only generate billing documents for active subscriptions.

  • Payment Methods - Made the following updates:

    • Removed the networkTransactionId field from the response body of the “Get stored credential profiles” operation.
    • Added the mitProfileAgreedOn field to the request body of the following operations:
      • Create payment method
      • Create credit card payment method
    • Added the agreedOn field to the request body of the “Create Stored Credential Profile” operation.
    • Added the MitProfileAgreedOn field to the request body of the “CRUD: Create payment method” operation.
  • Payment Gateway Reconciliation - Added the Payment Gateway Reconciliation section that includes the following operations:

    • Settle Payment
    • Reject Payment
    • Reverse Payment

 

Doc Updates

 

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

 

  • In the descriptions of the following operations, noted that these API operations are now in Limited Availability:

    • Get billing information for order
    • Request breakdown of invoice items by order
    • Get breakdown of invoice by order
    • Request breakdown of credit memo items by order
    • Get breakdown of credit memo by order
  • In the response body of the “CRUD: Get usage” operation, corrected the description of the CreatedDate field.

  • Renamed the Link Queries section to Data Queries. Also renamed the operations in this section:

    • Renamed “Submit Link query” to “Submit data query”.
    • Renamed “Get Link query jobs” to “Get data query jobs”.
    • Renamed “Get Link query job” to “Get data query job”.
    • Renamed “Cancel Link query job” to “Cancel data query job”.
  • In the source YAML file, renamed the following reference objects:

    • Renamed SubmitLinkQueryRequest to SubmitDataQueryRequest.
    • Renamed SubmitLinkQueryResponse to SubmitDataQueryResponse.
    • Renamed GetLinkQueryJobsResponse to GetDataQueryJobsResponse
    • Renamed GetLinkQueryJobResponse to GetDataQueryJobResponse.
    • Renamed DeleteLinkQueryJobResponse to DeleteDataQueryJobResponse.
    • Renamed LinkQueryJobCommon to DataQueryJobCommon.
    • Renamed LinkQueryJob to DataQueryJob.
    • Renamed LinkQueryJobCancelled to DataQueryJobCancelled.
    • Renamed LinkQueryErrorResponse to DataQueryErrorResponse.
  • Added the X-Zuora-WSDL-Version request header to the following actions:

    • Amend
    • Create
    • Delete
    • Execute
    • Generate
    • Query
    • QueryMore
    • Subscribe
    • Update
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!

 

2019-05-27

 

API Updates

 

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

 

The following API updates are available as of Zuora Release 247, May 2019.

 

  • Contacts - Changed the behavior of the “CRUD: Update contact” operation. You can now edit contacts for canceled accounts.

 

Doc Updates

 

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

 

  • In the response body of the “Get product catalog” operation, noted the array size limit to the description of the products > productRatePlans field.

  • In the response body of the “Get product” operation, noted the array size limit to the description of the productRatePlans field.

  • In the “Upload file for credit memo” operation, changed the path parameter name from id to creditMemoId.

  • In the “Upload file for debit memo” operation, changed the path parameter name from id to debitMemoId.

  • In the “Upload file for invoice” operation, changed the path parameter name from id to invoiceId.

  • In the response body of the Update action, corrected the type of the fieldsToNull nested field from string to array.

  • In the source YAML file, renamed the CreatePMPayPalEC&PayPalNativeEC reference object to CreatePMPayPalECPayPalNativeEC.

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-06-12

 

Doc Updates

 

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

 

  • In the request body of the "CRUD: Update payment method" operation, updated the note of the AccountId field to say that, if a payment method is already associated with a customer account, you cannot update the payment method to associate it with another account ID.

  • In the request body of the "Create credit card payment method" operation, corrected the cardHolderInfo > cardHolderName field from optional to required.

  • In the introduction of the "Create payment method" operation, updated the description for the credit card method to emphasize that the cardHolderInfo > cardHolderName field in the request body is required for this type of payment method.

  • In the descriptions of the following actions, added the limitations of supported object types:

    • Create
    • Update
  • In the “Write off invoice” operation, simplified the request example.

  • In the response body of the “CRUD: Get rate plan charge” operation, corrected ServiceActivationDate to ServiceActivation in the description of the TriggerEvent field.

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-06-20

 

API Updates

 

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

 

The following API updates are available as of Zuora Release 249, June 2019.

 

  • Payment Methods - Added the cardSecurityCode field in the request body of the “Create stored credential profile” operation.

 

Doc Updates

 

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

 

  • In the request body of the “Subscribe” action, added the description for the subscribes > PreviewOptions > EnablePreviewMode field as a workaround to avoid potential charges for payment method validation in subscription and amendment previews.

  • In the descriptions of the "Create order" and "Preview order" operations, added notes to inform customers about the limits on Orders.

  • In the Authorization header parameter of the following operations, added the description that the OAuth token must be regenerated after the Notification and the Configurable Event features are enabled in your Zuora tenant:

    • Create a notification definition
    • Query notification definitions
    • Update a notification definition
    • Get a notification definition
    • Delete a notification definition
    • Create an email template
    • Query email templates
    • Update an email template
    • Get an email template
    • Delete an email template
  • In the eventCategory query parameter of the following operations, added the description that two formats are supported:

    • Get callout notification histories
    • Get email notification histories
  • In the response body of the "Get account" operation, added the missing sequenceSetId nested field to the basicInfofield.

  • Corrected the endpoint URL of the "Upload file for invoice" operation to /v1/invoices/{invoice-id}/files.

  • Corrected the endpoint URL of the "Upload file for credit memo" operation to /v1/creditmemos/{creditMemoId}/files.

  • Corrected the endpoint URL of the "Upload file for debit memo" operation to /v1/debitmemos/{debitMemoId}/files.

  • In the following operations, changed the path parameter name from invoice-id to invoiceId.

    • Get invoice files
    • Get invoice items
  • In the “Get taxation items of invoice item” operation, changed the following path parameter names:

    • Changed invoice-id to invoiceId
    • Changed item-id to itemId
  • In the response body of the "Get product catalog" operation, corrected the URL example in the description of the products > productRatePlans field.

  • In the response body of the "Get product" operation, corrected the URL example in the description of the productRatePlans field.

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-06-28

 

Doc Updates

 

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

 

  • In the request body of the “Create a notification definition” operation, added an example of how to get the communication profile Id to the description of the communicationProfileId field.

  • In the request body of the following operations, updated the description of the subscriptions > orderActions > updateProduct > specificUpdateDate field to add more information about how to use this field:

    • Create order
    • Preview order
  • In the response body of the following operations, updated the description of the order(orders) > subscriptions > orderActions > updateProduct > specificUpdateDate field to add more information about how to use this field:

    • Get an order
    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get order metrics for evergreen subscription
  • In the description of the "Create authorization" and "Cancel authorization" operations, added the missing "Chase Paymentech Orbital" and "Ingenico ePayments" to the payment gateways that support both operations.

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-07-04

 

Doc Updates

 

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

 

  • In the response body of the "Get account" operation, added the following missing nested fields to the metrics fields:

    • totalDebitMemoBalance
    • unappliedPaymentAmount
    • unappliedCreditMemoAmount
  • In the 200 response body of the "CRUD: Get payment" operation, added the missing Processing enum value to the Status field.

  • In the request body of the "CRUD: Create payment method" operation, made the following updates:

    • Added the missing BankTransferAccountName, BankTransferAccountNumber, and BankTransferAccountNumberMask fields.

    • Added the missing SEPA enum value for the BankTransferType field.

  • In the response body of the "CRUD: Get payment method" operation, made the following updates:

    • Added the missing BankTransferAccountNumber field.

    • Added the missing SEPA enum value for the BankTransferType field.

  • In the request body of the "Amend" action, updated the description of the requests > Amendments > CustomerAcceptanceDate field to add more information about how to use this field.

  • In the request body of the "CRUD: Update amendment" operation, updated the description of the CustomerAcceptanceDate field to add more information about how to use this field.

  • In the response body of the "CRUD: Get amendment" operation, updated the description of the CustomerAcceptanceDate field to add more information about how to use this field.

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-07-11

 

API Updates

 

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

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

 

  • Invoices - In the request body of the "CRUD: Update invoice" operation, changed the behavior of the RegenerateInvoicePDF field by adding a limit that you can use this field to regenerate PDF files for the same invoice for at most 100 times.

 

Doc Updates

 

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

 

  • In the request body of the "CRUD: Update invoice" operation, added the missing RegenerateInvoicePDF field.

  • In the description of the "Create authorization" operation, made the following updates:

    • Clarified the subsequent operations as part of the Delayed Capture feature.
    • Added a known limitation of the Delayed Capture feature.
  • In the description of the "CRUD: Create payment" operation, clarified that this operation cannot work if the Invoice Settlement feature is enabled.

  • In the request body of the "CRUD: Create payment method" operation, removed the MitProfileAgreedOn field. The details of this field are moved to the PaymentMethod article in Zuora's Knowledge Center.

  • In the request body of the "Amend" action, updated the description of the requests > Amendments > ServiceActivationDate field to add more information about how to use this field.

  • In the request body of the "CRUD: Update amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field.

  • In the response body of the "CRUD: Get amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field.

  • Corrected the endpoints of the following asynchronous Orders operations:

    • Preview order asynchronously
    • Create order asynchronously
    • Get job status and response
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-07-21

 

API Updates

 

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

 

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

 

  • Contacts - Changed the behavior of the “Scrub contact” operation. The value of the country field becomes null instead of 0 after scrubbing as of this release.

 

Doc Updates

 

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

 

  • In the request body of the "CRUD: Create usage", made the following updates:

    • Added the following missing fields:
      • ChargeNumber
      • Description
      • SubscriptionNumber
    • Removed the unsupported Rbestatus field.
  • In the response body of the "CRUD: Create usage", added the following missing fields:

    • Description
    • SubscriptionNumber
Highlighted
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-07-26

 

API Updates

 

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

 

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

 

  • Credit Memos - Changed the behavior of the "Apply credit memo" operation. You can now use this operation to perform the following operations:

    • Apply negative credit memo items to negative invoice items or debit memo items.
    • Apply negative credit memo items to the taxation items of negative invoice items or debit memo items.
    • Apply the taxation items of negative credit memo items to negative invoice items or debit memo items.
    • Apply the taxation items of negative credit memo items to those of negative invoice items or debit memo items.
  • Debit Memos - Changed the behavior of the "Create debit memo from charge" operation. You can now use this operation to create negative debit memo items from negative product rate plan charges.

  • Invoices - Changed the behavior of the "Create debit memo from invoice" operation. You can now use this operation to create negative debit memo items from negative invoice items.

 

Doc Updates

 

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

 

  • In the "Create payment method" operation, made the following updates:

    • Added the following missing fields to the request body:

      • bankABACode
      • achBankAccountName
      • achBankAccountNumber
      • achBankAccountType
      • achBankName
      • addressLine1
      • addressLine2
      • phone
      • city
      • country
      • state
      • zipCode
    • Clarified that these fields are applicable to ACH payment methods.

  • In the "Get revenue schedule by invoice item adjustment" operation, corrected the description of the invoice-item-adj-key path parameter.

  • In the code sample of the request body for the following operations:

    • Create revenue schedule for credit memo item (distribute by date range)
    • Create revenue schedule for debit memo item (distribute by date range)

    Made the following updates:

    • Removed the redundant top-level application/json field.
    • Corrected the eventType and eventTypeSystemId field to avoid confusion.
  • In the request body of the following operations, corrected the data type of the billingCycleDay field to string:

    • Create payment run
    • Update payment run
  • In the response body of the "Get payment run" operation, corrected the data type of the billingCycleDay field to string.