{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-other-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Zuora Revenue API introduction"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"zuora-revenue-api-introduction","__idx":0},"children":["Zuora Revenue API introduction"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":1},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As part of the transition to OneID OAuth authentication, the host name for all Revenue API endpoints has changed to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one.zuora.com"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":2},"children":["Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you use the Zuora Revenue APIs, make sure the following requirements are met:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webservices Inbound"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webservices Outbound"]}," previleges in Zuora Revenue security settings. For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.zuora.com?resourceId=revenue-user-mgmt-access","target":"_blank"},"children":["Manage User Access"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the inbound operations to upload data into Zuora Revenue, the upload templates must be created by using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["File Upload"]}," menu options in the Zuora Revenue UI. Currently, the APIs support transaction upload, bundle upload, and event upload."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the outbound operations, the outbound GL interface mapping must be set up in the Zuora Revenue UI (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setups > Application > Interface Setup"]},")."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requests-and-responses","__idx":3},"children":["Requests and responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Zuora Revenue APIs support the JSON format of HTTP responses. Inbound operations for data upload support the CSV format only."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"inbound-data-error","__idx":4},"children":["Inbound data error"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the data fails in the CUST_UI tables, the entire batch of records will be marked as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Any uncollected data that remains in the staging tables can be manually fixed or downloaded, and can be reposted from the upstream systems."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the Stage Error operations to retrieve error information about the uploaded data."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"object-model","__idx":5},"children":["Object model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the detailed object model, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.zuora.com/en/zuora-revenue/month-end-process/revenue-data-access-and-models/zuora-revenue-data-object-model","target":"_blank"},"children":["Zuora Revenue Object Model"]},"."]}]},"headings":[{"value":"Zuora Revenue API introduction","id":"zuora-revenue-api-introduction","depth":1},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Requirements","id":"requirements","depth":2},{"value":"Requests and responses","id":"requests-and-responses","depth":2},{"value":"Inbound data error","id":"inbound-data-error","depth":2},{"value":"Object model","id":"object-model","depth":2}],"frontmatter":{"seo":{"title":"Zuora Revenue API introduction"}},"lastModified":"2026-10-28T21:31:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/other-api/revenue-api-intro","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}