Community - About Lanxin

Jing

This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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! 2021-01-12 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 290, January 2021. Actions - Made the following updates: In the request body of the "Amend" action, added the following nested fields to the AmendOptions field: ApplicationOrder ApplyCredit In the response body of the "Amend" action, added the following fields: CreditMemoDatas field and its nested fields CreditMemoId In the request body of the "Subscribe" action, added the following nested fields to the subscribes > SubscribeOptions field: ApplicationOrder ApplyCredit In the response body of the "Subscribe" action, added the following fields: CreditMemoData field and its nested fields CreditMemoId CreditMemoNumber CreditMemoResult field and its nested fields Payments - In the response body of the "CRUD: Get payment" operations, added the following fields: AppliedAmount UnappliedAmount Invoices - In the response body of the "Write off invoice" operation, added the support for NetSuite custom fields. Exports - Explained the newly enforced Data Source Export limits in the descritpion of the “CRUD: Create Export” operation. Notifications - Added the following operations: Delete notification histories for an account Get a notification history deletion task Orders - Made the following updates to add the applyDiscountTo and discountLevel fields to the Update product order action in all the Orders APIs. In the request body of each of the following operations: Create order Create order asynchronously Preview order Preview order asynchronously Added the following fields: subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > discountLevel In the response body of each of the following operations: Get an order Get order metrics for evergreen subscription Added the following fields: order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo In the response body of each of the following operations: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Added the following fields: orders > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo orders > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo Subscriptions - Made the following updates for a new field on the Subscription object. In the response body of each of the following operations, added the revision field. Get subscriptions by key and version Get subscriptions by key In the response body of the "Get subscriptions by account" operation, added the revision field in the subscriptions nested field. In the "CRUD: Retrieve Subscription" operation: Added the X-Zuora-WSDL-Version request header parameter. Added the Revision field in the response body. Doc Updates This section lists the documentation updates that were made in this version of the API Reference. In the "Payment Methods" section, added the following missing operations: Update payment method Get payment method Removed the incorrect Id path parameter from the request sample in the "CRUD: Update Subscription" operation.

Lanxin · ‎05-14-2020

We are excited to announce that we have published the enhanced error code documentation for Zuora Billing REST API! If a request to Zuora Billing REST API with an endpoint starting with /v1 (except Actions and CRUD operations) fails, the response will contain an eight-digit error code with a corresponding error message to indicate the details of the error. For example: "reasons": [ { "code": 53100320, "message": "'termType' value should be one of: TERMED, EVERGREEN" } To help you troubleshoot when you receive such error codes, we have published the following documentation: In the API Reference, we added a new Error Handling section to generally explain the two components of error codes. In the Knowledge Center, we published the Resource codes for Billing REST API to list all available resource codes as part of the error codes. These updates were also announced in the Release Notes and the API Changelog for Zuora Billing R275. We will continue to iterate the documentation for error codes and strive to make the documentation usable and valuable to you. If you have any comments or suggestions, feel free to contact the Documentation team (docs@zuora.com). Thanks for your help!

Lanxin · ‎03-30-2020

Zuora RevPro 37.001.00.00 will be released on April 14, 2020. The Release Notes for Zuora Billing - RevPro Integration based on RevPro 37.001.00.00 is now available. The important enhancements in this release include: Support for syncing currency exchange rate from Zuora Billing into RevPro Support for migrating custom field mappings Data Transformation progress available for tracking New parameter now available for RevPro3.0 Sync Object Mapping For details about the enhancements and UI changes in the upcoming version, please see Zuora Billing - RevPro Integration Release Notes.

Lanxin · ‎02-14-2020

Zuora RevPro 36.011.01.00 patch will be released on February 17, 2020. The Release Notes for Zuora Billing - RevPro Integration based on RevPro 36.011.01.00 patch is now available. Several issues have been resolved in this release. For details about the resolved issues in the latest version, please see Zuora Billing - RevPro Integration Release Notes.

Lanxin · ‎01-20-2020

We are pleased to announce that the Release Notes for Zuora Billing - RevPro Integration based on RevPro 36.011.00 patch has been published! The enhancements in this patch include: Transformation Job UI now available under Data Interface For more details about enhancements and resolved issues in the latest version, please see Zuora Billing - RevPro Integration Release Notes.

Lanxin · ‎01-06-2020

We are pleased to announce that the Release Notes for Zuora Billing - RevPro Integration based on RevPro 36.010.11 patch has been published! The enhancements in this patch include: Support for performing allocation for ramp deals For more details about enhancements and resolved issues in the latest version, please see Zuora Billing - RevPro Integration Release Notes.

Lanxin · ‎12-22-2019

We are pleased to announce that the Release Notes for Zuora Billing - RevPro Integration based on RevPro 36.010.09 patch has been published! The enhancements in this patch include: Enhanced CA/CL netting process For more details about enhancements and resolved issues in the latest version, please see Zuora Billing - RevPro Integration Release Notes.

Lanxin · ‎12-11-2019

We are pleased to announce that the Release Notes for Zuora Billing - RevPro Integration based on RevPro 36.010.08 patch has been published! The enhancements in this patch include: CCV Report for Zuora Billing now available Data Transformation scheduler introduced New indicator available in Billings layout in RC Workbench Zuora Billing objects and fields supported by query filter in Data Transformation For more details about enhancements and resolved issues in the latest version, please see Zuora Billing - RevPro Integration Release Notes.

Muhan · ‎11-03-2019

Remember that you must be assigned to the role with the privilege to release the lock. To find the role privileges, perform the following steps (in the new UI): Navigate to Setups > Security. On the Roles page, hover the mouse over the target role and click the pencil icon. In the Edit Role window, click Role Privileges. In the Text column, drill down to Setups > Application > Release Lock. Ensure Full Access is assigned in the Privilege column for the Release Lock line.

mikemartin · ‎09-18-2019

Well done Zuora for getting this one out of the door for Cybersource. We'll kick the tyres in in our Greenfield project and let you know how we get on

Lanxin · ‎03-28-2019

Hi AprilD: I probably know the answer to your first question. Hope I can help for a bit. Initial Entry: The entries with "Initial Entry Flag" set to "Yes" are the entries assumed to be created outside of RevPro. As such they are one-sided entries that are also flagged as "Unpostable". The Initial Entries Flag is set for billings and initial cost entries (based on cost-type setup). Initial Reporting Entry: The purpose of the Initial Reporting Entry flag is primarily used for reporting within RevPro and for flagging initial entries in the Balance Sheet created in RevPro. These include the Allocation Adjustment entries for the carve-outs between lines (Adjustment Liability), the accrual entries created for variable consideration, and the initial cost entries where RevPro posts both the Capitalized Cost and the Liability entries. This flag allows transactions to be flagged as "Additions" in RevPro reporting, but separates them from the entries generated outside RevPro and allows users to segregate initial entries for reconciliation purposes. So I guess you can use this flag to filter journal entries. Additionally, you might want to refer to Reports Reconciliation in our Knowledge Center for more information on the reports reconciliation. Thanks!

Lanxin · ‎03-09-2019

We are pleased to announce that the Zuora RevPro 36.004.00 Release Notes has been published! The important enhancements in this release include (but not limited to): Improved VC Upload Filter Configurable VC Upload Template Columns View Accounting Details for Specific VC Type Support to Correct VC Upload Errors from UI Support CL/CA ReClass for VC Accounting Entries in Netting Process The top issues resolved in this release include (but not limited to): Impairment entry is not created for the SO update with canceled carve-out lines. The unreleased revenue value is wrong for the bundle SO lines. Waterfall schedules are not correctly created for the quantity/price/term contract modifications. Even though the RC is on hold at the RC level, revenue is still released when the event process program runs. The LTST schedules do not match the MJE lines. For example, the LT liability is a negative value but the corresponding JE contains a positive value. For more details about new features, enhancements, and resolved issues, please see Zuora RevPro 36.004.00 Release Notes. You can bookmark the URL of the Release Notes to always get the information about the latest version. For previous releases, see Previous Zuora RevPro Releases.

Lanxin · ‎01-14-2019

Hi Hassan, This looks a little strange to me because I tested this call and got the right response as expected. I am assuming there is some illegal data in this account or the misconfiguration for your tenant. In this case, I suggest you submit a ticket at Zuora Global Support and our support agents could help you further troubleshoot this problem. Thanks!

stefanomurino · ‎12-03-2018

Thank you very much, I solved with your directions!

Lanxin · ‎11-19-2018

We are pleased to announce that the Zuora RevPro 36.001.00 Release Notes has been published! From the November Release, 2018, Zuora RevPro is updating its version naming convention. The latest release version is 36.001.00. Please check out Zuora RevPro 36.001.00 Release Notes for details. The enhancements in this release include: Netting Report Now Available Support for Associating Filters to Existing Report Layouts Enhancement in Netting Process for MJEs Permissions Enabled for Report Layouts SOB ID and Currency Code Auto-Population into MJE Now in General Availability The resolved issues in this release include: Unsupported POB Dependency Types in UI Netting Performed at Both Contractual and Adjustment Levels Waterfall Not Updated with Term Changes on RC Lines Contra AR Account Entries Not Knocked Off after CM-RO or RORD Lines are Collected Percent-Based POB Not Released Correctly If SO or INV Updated with Decreased Selling Price

Lanxin · ‎08-06-2018

We are pleased to announce that the Zuora RevPro 3.6.0.0 Release Notes has been published! Please check out Zuora RevPro 3.6.0.0 Release Notes for details. The enhancements in this release include: New Release Revenue Option in Approval Rule Forecasting Dates Customization SFC Amount Available to be Split at Different Levels Validation Process Master Program Enhanced for Multi-Org Support for Handling Prorated Lines The resolved issues in this release include: Overstated and Understated Revenue Recognition Issues upon Full Billing Revenue Automatically Re-Released on Deferral Adjustment Revenue Not Reflected in Accounting and Waterfall after Cost Upload Unbalanced Entries in Schedules Allocatable Amount Exists When ESP and SSP are Zero

Lanxin · ‎07-26-2018

Hi rogeriopvl, I did a quick investigation on this issue and it turned out it's the payment gateway who declined the auth request and the error message is returned by the gateway. No detail was provided. In order to dig out the root cause, I suggest you submit a ticket at Zuora Global Support to let our support agents assist you to figure out the solution. For your card testing cases, it really depends on the payment gateway you want to test. Please refer to Test Credit Card numbers posted on Community and the How do I test my gateway? article in KC for more information. Hope it helps!

Lanxin · ‎05-03-2018

We are pleased to announce that the Zuora RevPro 3.5.0.0 Release Notes has been published! Please check out Zuora RevPro 3.5.0.0 Release Notes for details. The enhancements in this release include: Revenue Contract Move Report Showing Delinked Lines Unsatisfied POB Balances Report Track Previously Satisfied POBs By Quarter and By Year New Release Event Available in Cost Treatment of POB Templates New Fields in SSP Percentage Based Templates and Reports The resolved issues in this release include: Cost Schedules Created Based on Old Dates after SO Term Change Workbench Does Not Display Event Detail for Unbundled Lines Catch-up Revenue Not Released When Ext Sell Price Change from $0 to Another Value Unable to Expire Line Level Release Hold Incorrect SSP Calculation

Lanxin · ‎03-31-2018

You should be able to see the following page when clicking your username on the top right corner and navigate to Billing Settings, Payment Settings, or Finance Settings > Setup Profiles, Notifications and Email Templates > Callout Options. This feature is in GA, which means your tenant should be can access this feature without making any extra effort. Thanks!

Lanxin · ‎03-12-2018

Thanks for pointing it out, Claude! I downloaded the YAML file from the API reference and found two issues: There is a typo in the YAML file, where the type "Integer" should be "integer". This is the root which causes the errors you pointed out. To correct this typo, search the Swagger file for the string "type: Integer" and replace with "type: integer". There are these two endpoints in the Swagger file: /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-id} and /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}. However, according to the Swagger 2.0 spec, {invoice-item-adj-id} and {invoice-item-adj-key} are treated as the same parameter by Swagger and it is not allowed to have two "identical paths" declared in the same YAML file. After checking the definition of both params, I think they are basically the same. To fix this issue, I recommend you to: a) Change the string /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-id} to /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} in the Swagger file. b) Replace the "- name: invoice-item-adj-id" to "- name: invoice-item-adj-key". c) Remove the other duplicated endpoint /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} for the "Create revenue schedule for Invoice Item Adjustment (manual distribution)" operation. Both these issues will be fixed in R222 Sandbox Release. You can either wait for our update and download again, or modify on your side. Hope it helps. Feel free to reply me if you have further questions. Thanks!

Lanxin · ‎03-01-2018

According to my investigation, I think the cause of this issue is probably that you used the wrong field names for ProxyPostPayment. The "accountId" and "paymentMethodId" fields are only for the Create Payment operation, not for ProxyPostPayment (CRUD: Create Payment). Thus, you can try to change the "accoundId" to AccountId, and "paymentMethodId" to PaymentMethodId in your code snippet. Hope it helps.

Lanxin · ‎12-06-2017

This issue is fixed in R219. You can now sign and make CORS enabled requests with uri like https://rest.zuora.com/v1/payment-methods/credit-cards as documented in the request body.

Happy Business Starts Here

Vision

Products

Zuora Central Platform

Products

Zuora Marketplace

Solutions

By Industry

By Role

Customers

Resources

Resources

Subscribed

Support

Company

Re: API Changelog

Enhanced error code documentation for Zuora Billing REST API

Zuora Billing - RevPro Integration Release Notes based on RevPro 37.001.00.00

Zuora Billing - RevPro Integration Release Notes based on RevPro 36.011.01.00

Zuora Billing - RevPro Integration Release Notes based on RevPro 36.011.00

Zuora Billing - RevPro Integration Release Notes based on RevPro 36.010.11

Zuora Billing - RevPro Integration Release Notes based on RevPro 36.010.09

Zuora Billing - RevPro Integration Release Notes based on RevPro 36.010.08

Re: How to Release the Lock through UI?

Re: PSD2 & SCA – How Zuora is Helping You Prepare

Re: Initial Entry vs Initial Reporting Entry

Zuora RevPro 36.004.00 Release Notes

Re: Empty Response from REST API

Re: Export Invoice Details and Payment

Zuora RevPro 36.001.00 Release Notes

Zuora RevPro 3.6.0.0 Release Notes

Re: Response error codes

Zuora RevPro 3.5.0.0 Release Notes

Re: Notification and Event API Changelog

Re: Zuora REST Swagger YAML Invalid

Re: Can't create payment via REST endpoint (ProxyPostPayment)

Re: What URL should be used in HMAC via the new REST API?