As part of the transition to OneID OAuth authentication, the host name for all Revenue API endpoints has changed to one.zuora.com.
Before you use the Zuora Revenue APIs, make sure the following requirements are met:
Zuora Revenue uses role based access control to restrict system access to authorized users. To use the Zuora Revenue APIs, make sure that your user role has the Webservices Inbound and Webservices Outbound previleges in Zuora Revenue security settings. For more information, see Manage User Access.
To use the inbound operations to upload data into Zuora Revenue, the upload templates must be created by using the File Upload menu options in the Zuora Revenue UI. Currently, the APIs support transaction upload, bundle upload, and event upload.
To use the outbound operations, the outbound GL interface mapping must be set up in the Zuora Revenue UI (Setups > Application > Interface Setup).
Zuora Revenue APIs support the JSON format of HTTP responses. Inbound operations for data upload support the CSV format only.
All the inbound data into Zuora Revenue are first loaded into pre-stage tables, namely CUST_UI tables in Zuora Revenue, and then pushed to the corresponding staging tables from CUST_UI tables.
If the data fails in the CUST_UI tables, the entire batch of records will be marked as Failed. It means All or Nothing approach will be followed when data is being inserted to the CUST_UI tables. If the data has been successfully inserted into the CUST_UI tables, it will then be automatically pushed to the staging tables and no manual work is required.
Any uncollected data that remains in the staging tables can be manually fixed or downloaded, and can be reposted from the upstream systems.
You can use the Stage Error operations to retrieve error information about the uploaded data.
For the detailed object model, see Zuora Revenue Object Model.