Zuora Product Documentation

https://docs.zuora.com/en
Admin
Zuora provides comprehensive product documentation for its suite of applications, including billing,...
Tokens:2,291,404
Snippets:32,523
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Tenant Settings API Example

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/additional-operations/get-tenant-settings

Example of an HTTPS GET request to retrieve tenant settings and the corresponding JSON response.

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/settings
```

```JSON
{ "success" : true, "response" : { "emailDomains" : [ "CorporationXYZ.com" ] } }
```

--------------------------------

### GET /api/integrations/v2/biviews-status/<task_id>

Source: https://docs.zuora.com/en/zuora-revenue/advanced-revenue-operations/integration-service-bi-views-v2/overview-of-bi-views-v2/activity-monitoring

Retrieves details for a specific continuation token.

```APIDOC
## GET /api/integrations/v2/biviews-status/<task_id>

### Description
Retrieves the details of a specific continuation token.

### Method
GET

### Endpoint
https://$tenant/api/integrations/v2/biviews-status/<task_id>

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The continuation token returned in the initial request.
```

--------------------------------

### GET /api/integrations/v2/biviews-status

Source: https://docs.zuora.com/en/zuora-revenue/advanced-revenue-operations/integration-service-bi-views-v2/overview-of-bi-views-v2/activity-monitoring

Retrieves status information for all continuation tokens.

```APIDOC
## GET /api/integrations/v2/biviews-status

### Description
Retrieves status information about all continuation tokens.

### Method
GET

### Endpoint
https://$tenant/api/integrations/v2/biviews-status
```

--------------------------------

### Full Client-Side Integration Example

Source: https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/define-and-set-up-payment-methods/set-up-google-pay-with-legacy-version-of-zuora-javascript-sdk

A complete example demonstrating the initialization, configuration object, and mounting of the Google Pay button.

```javascript
const zuora = Zuora('vIMyxqZKEk7gzUQtGZ1M1fTJBMHhKZH1'); const configuration = { environment: "api_sandbox", paymentRequest: { country: "US", currency: "USD", amount: 100, supportedNetworks: ['visa','masterCard','amex', 'discover'] }, style: { buttonStyle: "default", buttonType: "buy", locale: "en" }, onSuccess: function (response) { console.info('paymentMethodId: ' + response.paymentMethodId); console.info('paymentId: ' + response.paymentId); }, onError: function (response) { console.error('code: ' + response.code); console.error('message: ' + response.message); } }; zuora.create('GooglePay', configuration).mount("#payment-request-button");
```

--------------------------------

### Get transfer batch list response example

Source: https://docs.zuora.com/en/zuora-revenue/advanced-revenue-operations/best-practice-for-using-revenue-apis

Example JSON response structure for the Get transfer batch list operation.

```json
{ "result": [ { "client_id": 1, "crtd_by": "string", "crtd_dt": "2021-09-20T18:39:50Z", "id": 10043, "name": "string", "status": "string", "updt_by": "string", "updt_dt": "2021-09-20T18:39:50Z", "report_id": 10003 } ], "status": "Success" }
```

--------------------------------

### Create an Account using SOAP API

Source: https://docs.zuora.com/en/zuora-platform/integration/apis/soap-api/soap-api-calls/create

Example demonstrating how to instantiate an Account object, set its properties, and execute the create() call.

```java
// create account Account acc = new Account(); acc.setName("Test Account"); acc.setBatch("Batch1"); acc.setBillCycleDay(1); acc.setAllowInvoiceEdit(true); acc.setCurrency("USD"); acc.setStatus("Draft"); ZObject[] objs = new ZObject[1]; objs[0] = acc; Create create = new Create(); create.setZObjects(objs); CreateResponse resp = stub.create(create, this.header); SaveResult[] res = resp.getResult(); ID accountId = res[0].getId();
```

--------------------------------

### Build New Quote Plans from Product Catalog

Source: https://docs.zuora.com/en/zuora-cpq/development-resources/zuora-cpq-component-library/zuora-cpq-global-classes/cpq-x-api/cpq-x-utilities/qplanbuilder-class

Demonstrates how to generate a list of QPlan objects for a specific quote using a list of Product Rate Plan IDs.

```Apex
public void test(){ String quoteId = 'quoteId_xxx'; List<Id> productRatePlanIds = new List<Id>{'rpId_xxx1', 'rpId_xxx2', 'rpId_xxx3'}; List<zqu.QPlan> plans = zqu.QPlanBuilder.makeFromCatalog(quoteId, productRatePlanIds); System.assert(plans.size() == 3); for(zqu.QPlan plan : plans){ // Check the type of Plan by looking at the Amendment System.assertEquals('NewProduct', plan.getAmendment().get('zqu__Type__c')); } }
```

--------------------------------

### Get report data response example

Source: https://docs.zuora.com/en/zuora-revenue/advanced-revenue-operations/best-practice-for-using-revenue-apis

Example JSON response structure for the Get report data operation, providing a signed URL.

```json
{ "signed_url": "<signed_url valid for 30 mins>", "success": true }
```

--------------------------------

### Get Report Run Request and Response Example

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-run

Example of an HTTPS GET request to retrieve report run details and the corresponding JSON response.

```http
GET https://zconnectsandbox.zuora.com/api/rest/v1/reportruns/ff808081529f4e3401529fd61f080074
```

```json
{ "success": true, "response": { "reportType": "Detail", "id": "ff808081529f4e3401529fd61f080074", "reportId": "ff808081529f4e3401529fd373730070", "startedOn": 1453166692000, "status": "COMPLETED", "reportDefinition": "...", "updatedOn": 1453166695000 } }
```

--------------------------------

### HTTP Request Configuration Example

Source: https://docs.zuora.com/en/zuora-platform/extensibility/mediation/meter-components/processors/http-processor/connection-configuration-references

Demonstrates how to use template variables for dynamic URL paths and authorization headers.

```json
{ "urlPath": "/customers/${event.customerId}", "headers": [ { "key": "Authorization", "value": "Bearer ${secrets.apiKey}" } ] }
```

--------------------------------

### Get Report Labels Example

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/additional-operations/get-report-labels-for-reportid

A concrete example of an HTTPS request and the corresponding JSON response for retrieving report labels.

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/reports/0000000050deb5e80150fe5c73990040/reportlabels
```

```JSON
{ "success" : true, "response" : [ { "createdBy" : "2c92c0f84ed8ca02014ee6604b8903af", "updatedBy" : "2c92c0f84ed8ca02014ee6604b8903af", "createdOn" : "2015-09-25T12:45:24-0700", "updatedOn" : "2015-09-25T12:45:24-0700", "id" : "00000000500258ba01500609e9790002", "deleted" : false, "name" : "Shared Reports", "type" : "Private", "parentId" : "000000004f531a08014f608ef1cd0065", "pshareId" : "000000004f531a08014f608ef1bc0064", "order" : 2, "userId" : "2c92c0f84ed8ca02014ee6604b8903af", "creator" : "tim.riley@zuora.com", "updater" : "tim.riley@zuora.com", "favorite" : false, "shared" : true, "zuora" : false, "home" : false, "root" : false, "labelNamePath" : "/1/Shared Reports" }, { "createdBy" : "2c92c0f84ed8ca02014ee6604b8903af", "updatedBy" : "2c92c0f84ed8ca02014ee6604b8903af", "createdOn" : "2015-09-25T12:46:08-0700", "updatedOn" : "2015-09-25T12:46:08-0700", "id" : "00000000500258ba0150060a93460003", "deleted" : false, "name" : "Invoices", "type" : "Private", "parentId" : "000000004f531a08014f608ef1cd0065", "order" : 3, "userId" : "2c92c0f84ed8ca02014ee6604b8903af", "creator" : "tim.riley@zuora.com", "updater" : "tim.riley@zuora.com", "favorite" : false, "shared" : false, "zuora" : false, "home" : false, "root" : false, "labelNamePath" : "/1/Invoices" } ] }
```

--------------------------------

### Java login() implementation

Source: https://docs.zuora.com/en/zuora-platform/integration/apis/soap-api/soap-api-calls/login/sample-code-for-login-call

Demonstrates how to authenticate using the login() method and configure the service client with the returned session and server URL.

```java
Login login = new Login();
login.setUsername("username@company.com");
login.setPassword("password");
LoginResponse resp = stub.login(login);
LoginResult result = resp.getResult();
// set new endpoint
ServiceClient client = stub._getServiceClient();
client.getOptions().getTo().setAddress(result.getServerUrl());
// create session for all subsequent calls
SessionHeader header = new SessionHeader();
header.setSession(result.getSession());
```

--------------------------------

### OpenWeb SSO Frontend Integration

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/openweb-single-sign-on-sso

Example implementation for initiating the OpenWeb SSO flow on the frontend, including the SPOTIM module launcher and the callback function to the Zephr SSO endpoint.

```html
<div data-spotim-module="pitc"></div><script async data-spotim-module="spotim-launcher" src="https://launcher.spot.im/spot/{{spot-id}}" data-post-id="12345"></script> <script> if (window.SPOTIM && window.SPOTIM.startSSO) { startSSO(); } else { document.addEventListener('spot-im-api-ready', startSSO, false); } // Prior to initiating this function, ensure that the user // is actively logged into your site function startSSO() { var callback = function(codeA, completeSSOCallback) { // call your backend to receive codeB and return it // to OpenWeb via completeSSOCallback function fetch('{{base-url}}/plugins/public/openweb-v2/sso', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ code_a: codeA, }), credentials: 'include' }).then(res => res.json()).then(res => { if(res.codeB){ completeSSOCallback(res.codeB) } }); }; window.SPOTIM.startSSO(callback).then(function(userData) { console.log(userData) }).catch(function(reason) { console.error(reason) }); } </script>
```

--------------------------------

### Get Report Details Request and Response

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/additional-operations/get-report-details

Example of an HTTPS GET request to retrieve report details and the corresponding JSON response.

```http
GET https://zconnectsandbox.zuora.com/api/rest/v1/reports/0000000050b0ade40150b4966498003f/report-details
```

```json
{ "success" : true, "response" : { "createdBy" : "8a8081d250440d000150a829710626fa", "updatedBy" : "8a8081d250440d000150a821c273268a", "createdOn" : "2015-10-29T10:12:46-0700", "updatedOn" : "2015-11-30T12:28:47-0800", "id" : "0000000050b0ade40150b4966498003f", "deleted" : false, "name" : "Gross MRR (as of date) over time", "number" : "REP0000270", "type" : "Common", "datasource" : "Rate Plan Charge", "dsName" : "RatePlanCharge", "description" : "RatePlanCharge.EffectiveDateRange (not New Date Range Field, but StartDate and EndDate), grouped by month\tProduct.Name, Account.Currency; Sum of RatePlanCharge.MRR; Subscription.Status is not in \"Expired\", \"Draft\"", "definition" : "{\"rowFields\":[{\"name\":\"Name\",\"id\":\"Product.Name\",\"label\":\"Name\",\"type\":\"text\",\"order\":8,\"dataSourceName\":\"Product\",\"dataSourceLabel\":\"Product\",\"dataSourceType\":\"Product\",\"searchKey\":\"Product Name\",\"sortDir\":\"NONE\",\"sortPriority\":-1,\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true},{\"name\":\"Currency\",\"id\":\"Account.Currency\",\"label\":\"Currency\",\"type\":\"text\",\"order\":14,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Currency\",\"options\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BHD\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BTN\",\"BWP\",\"BYR\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CUP\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EEK\",\"EGP\",\"ERN\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"IQD\",\"IRR\",\"ISK\",\"JMD\",\"JOD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KPW\",\"KRW\",\"KWD\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"LTL\",\"LVL\",\"LYD\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"OMR\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SDG\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SVC\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VEF\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMK\",\"ZWD\"],\"sortDir\":\"NONE\",\"sortPriority\":-1,\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true}],\"colFields\":[{\"name\":\"EffectiveStartDate\",\"id\":\"RatePlanCharge.EffectiveStartDate\",\"label\":\"Effective Start Date\",\"type\":\"date\",\"order\":19,\"dataSourceName\":\"RatePlanCharge\",\"dataSourceLabel\":\"Rate Plan Charge\",\"dataSourceType\":\"RatePlanCharge\",\"searchKey\":\"Rate Plan Charge Effective Start Date\",\"sortDir\":\"NONE\",\"sortPriority\":-1,\"dateOptions\":{\"groupBy\":\"CM\",\"cohortAnalysis\":false},\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true},{\"name\":\"EffectiveEndDate\",\"id\":\"ProductRatePlan.EffectiveEndDate\",\"label\":\"Effective End Date\",\"type\":\"date\",\"order\":4,\"dataSourceName\":\"ProductRatePlan\",\"dataSourceLabel\":\"Product Rate Plan\",\"dataSourceType\":\"ProductRatePlan\",\"searchKey\":\"Product Rate Plan Effective End Date\",\"sortDir\":\"NONE\",\"sortPriority\":-1,\"dateOptions\":{\"groupBy\":\"CM\",\"cohortAnalysis\":false},\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true}],\"valFields\":[{\"name\":\"MRR\",\"id\":\"RatePlanCharge.MRR\",\"label\":\"MRR\",\"type\":\"decimal\",\"aggregation\":\"SUM\",\"order\":23,\"dataSourceName\":\"RatePlanCharge\",\"dataSourceLabel\":\"Rate Plan Charge\",\"dataSourceType\":\"RatePlanCharge\",\"searchKey\":\"Rate Plan Charge MRR\",\"extendedType\":\"Currency\",\"relatedField\":\"Account.Currency\",\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true}],\"summaryFilters\":[{\"field\":{\"name\":\"Status\",\"id\":\"Subscription.Status\",\"label\":\"Status\",\"type\":\"text\",\"order\":21,\"dataSourceName\":\"Subscription\",\"dataSourceLabel\":\"Subscription\",\"dataSourceType\":\"Subscription\",\"searchKey\":\"Subscription Status\",\"options\":[\"Draft\",\"Pending Activation\",\"Pending Acceptance\",\"Active\",\"Cancelled\",\"Expired\"],\"groupable\":true,\"sortable\":true,\"custom\":false,\"filterable\":true},\"value\":\"Expired\",\"operator\":{\"name\":\"is not equal
```

--------------------------------

### Mylo Login Example

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/mylo/implement-the-mylo-login-flow

This script fetches client configuration from Zephr and dynamically generates a Mylo sign-in link.

```javascript
<div id="mylo-login-link">Loading Mylo Sign In link...</div> <script> function clientConfig() { var client = new (XMLHttpRequest || ActiveXObject)("MSXML2.XMLHTTP.3.0"); client.open( "GET", `/plugins/public/mylo/clientConfig?startingUrl=${window.location.href}`, null ); client.onload = function () { if (client.status === 200) { var response = JSON.parse(client.responseText); document.getElementById("mylo-login-link").innerHTML = '<a href="https://ciam-ui.kubestage.hearstapps.net/login?client_id=' + response.clientId + "&redirect_uri=" + encodeURIComponent(response.loginRedirectUrl) + "&state=" + response.state + '">Sign In</a>'; } else { console.log("can not fetch client config"); document.getElementById("mylo-login-link").innerHTML = "can not get Mylo Sign In link"; } }; client.setRequestHeader("Content-type", "application/json"); client.setRequestHeader("X-Referer", "localhost"); client.withCredentials = true; client.send(); } clientConfig(); </script>
```

--------------------------------

### Get Report Details by Label Request and Response

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/additional-operations/get-report-details-by-label

Example of an HTTPS GET request to retrieve report details and the corresponding JSON response.

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/reports/reportlabels/0000000050f7c2700150f8ee1d580090/report-details
```

```JSON
{ "success" : true, "response" : [ { "createdBy" : "8a8081d250440d000150a829710626fa", "updatedBy" : "8a8081d250440d000150a829710626fa", "createdOn" : "2015-11-20T13:04:03-0800", "updatedOn" : "2015-11-20T13:07:35-0800", "id" : "0000000051267fea015126b6083f0085", "deleted" : false, "name" : "Account Sales Rep", "number" : "REP0000376", "type" : "Common", "datasource" : "Invoice Item", "dsName" : "InvoiceItem", "definition" : "{\"rowFields\":[{\"name\":\"AccountNumber\",\"id\":\"Account.AccountNumber\",\"label\":\"Account Number\",\"type\":\"text\",\"order\":1,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Account Number\",\"sortDir\":\"NONE\",\"sortPriority\":-1,\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false},{\"name\":\"Currency\",\"id\":\"Account.Currency\",\"label\":\"Currency\",\"type\":\"text\",\"order\":14,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Currency\",\"options\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BHD\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BTN\",\"BWP\",\"BYR\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CUP\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EEK\",\"EGP\",\"ERN\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"IQD\",\"IRR\",\"ISK\",\"JMD\",\"JOD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KPW\",\"KRW\",\"KWD\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"LTL\",\"LVL\",\"LYD\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"OMR\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SDG\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SVC\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VEF\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMK\",\"ZWD\"],\"sortDir\":\"NONE\",\"sortPriority\":-1,\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false}],\"colFields\":[{\"name\":\"SalesRepName\",\"id\":\"Account.SalesRepName\",\"label\":\"Sales Rep\",\"type\":\"text\",\"order\":28,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Sales Rep\",\"sortDir\":\"NONE\",\"sortPriority\":-1,\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false}],\"valFields\":[{\"name\":\"CreditBalance\",\"id\":\"Account.CreditBalance\",\"label\":\"Credit Balance\",\"type\":\"decimal\",\"aggregation\":\"SUM\",\"order\":12,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Credit Balance\",\"extendedType\":\"Currency\",\"relatedField\":\"Account.Currency\",\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false},{\"name\":\"Status\",\"id\":\"Account.Status\",\"label\":\"Status\",\"type\":\"picklist\",\"aggregation\":\"COUNT\",\"order\":29,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Status\",\"options\":[\"Draft\",\"Active\",\"Canceled\"],\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false}],\"detailFilters\":[{\"field\":{\"name\":\"BillCycleDay\",\"id\":\"Account.BillCycleDay\",\"label\":\"Bill Cycle Day\",\"type\":\"integer\",\"order\":8,\"dataSourceName\":\"Account\",\"dataSourceLabel\":\"Account\",\"dataSourceType\":\"Account\",\"searchKey\":\"Account Bill Cycle Day\",\"options\":[\"0\",\"1\",\"2\",\"3\",\"4\",\"5\",\"6\",\"7\",\"8\",\"9\",\"10\",\"11\",\"12\",\"13\",\"14\",\"15\",\"16\",\"17\",\"18\",\"19\",\"20\",\"21\",\"22\",\"23\",\"24\",\"25\",\"26\",\"27\",\"28\",\"29\",\"30\",\"31\"],\"groupable\":true,\"sortable\":true,\"filterable\":true,\"custom\":false},\"value\":[2,\"3\",\"4\",\"5\"],\"operator\":{\"name\":\"not in\",\"value\":\"not in\"}}],\"summaryFilters\":[],\"selectedFields\":[],\"shareAsReadOnly\":false}", "version" : 1, "userId" : "8a8081d250440d000150a829710626fa", "creator" : "tim@zuora.com", "updater" : "tim@zuora.com", "executedOn" : 1448053655000, "favorite" : false, "shared" : true, "zuora" : }
```

--------------------------------

### Manipulate Products with zChargeGroup and QPlan

Source: https://docs.zuora.com/en/zuora-cpq/zuora-cpq-setup/upgrade-from-legacy-cpq-ui-to-quote-studio-ui/sample-code-using-zchargegroup

This example illustrates the process of creating a quote, adding products, and updating charge details using both legacy zChargeGroup and modern QPlan APIs.

```apex
public class SampleProductAdd { public static void sampleProductManipulation() { zqu.Quote quote = zqu.Quote.getNewInstance(); quote.set('Name', 'My Product Manipulation Test Quote'); quote.set('zqu__StartDate__c', Date.newInstance(2025, 1, 1)); quote.set('zqu__InitialTerm__c', 12); // populate other Quote fields quote.save(); Id quoteId = quote.getId(); Id productRatePlanId = 'a0cEc000006HELbIAO'; Id productChargeId = 'a0aEc00000LH956IAD'; //===== add product to Quote via zChargeGroup ===== zqu.zChargeGroup newChargeGroup = zqu.zQuoteUtil.getChargeGroup(quoteId, productRatePlanId); if (newChargeGroup == null) { throw new zqu.CustomValidationException('Fail to add product ' + productRatePlanId + ' to Quote, Product not found or expired.'); } newChargeGroup.productName = 'Product added by zChargeGroup'; zqu.zQuoteUtil.addChargeGroup(newChargeGroup); //===== update product of Quote via zChargeGroup ===== List<zqu.zChargeGroup> currentChargeGroups = zqu.zQuoteUtil.getChargeGroups(quoteId); for (zqu.zChargeGroup chargeGroup : currentChargeGroups) { if (chargeGroup.productRatePlanId == productRatePlanId) { chargeGroup.contractEffectiveDate = Date.newInstance(2025, 2, 1); for (zqu.zCharge charge : chargeGroup.zCharges) { if (charge.PRODUCT_RATE_PLAN_CHARGE_SFDC_ID == productChargeId) { charge.EFFECTIVE_PRICE = '19.99'; charge.QUANTITY = '10'; } } } } zqu.zQuoteUtil.updateChargeGroups(currentChargeGroups); //===== add product to Quote via QPlan ===== List<zqu.QPlan> newQPlans = zqu.QPlanBuilder.makeFromCatalog(quoteId, new List<ID>{ productRatePlanId }); if (newQPlans.size() < 1) { throw new zqu.CustomValidationException('Fail to add product ' + productRatePlanId + ' to Quote, Product not found or expired.'); } for (zqu.QPlan qPlan : newQPlans) { qPlan.put('zqu__QuoteProductName__c', 'Product added by QPlan'); } zqu.QPlanWriter.save(newQPlans); //===== update product of Quote via QPlan ===== List<zqu.QPlan> currentQPlans = zqu.QPlanReader.load(quoteId); for (zqu.QPlan qPlan : currentQPlans) { if (qPlan.get('zqu__ProductRatePlan__c') == productRatePlanId) { qPlan.getAmendment().put('zqu__ContractEffectiveDate__c', Date.newInstance(2025, 2, 1)); for (zqu.QCharge qCharge : qPlan.getCharges()) { if (qCharge.get('zqu__ProductRatePlanCharge__c') == productChargeId) { qCharge.put('zqu__EffectivePrice__c', 19.99); qCharge.put('zqu__Quantity__c', 10); } } } } zqu.QPlanWriter.save(currentQPlans); } }
```

--------------------------------

### Get Report Data Request and Response

Source: https://docs.zuora.com/en/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-data

Example of an HTTPS GET request to retrieve report data and the corresponding JSON response structure.

```http
GET https://zconnectsandbox.zuora.com/rest/v1/reportruns/reportdata/ff8080815242b012015261b9f77009a0?offset=1&pageSize=100
```

```json
{ "success" : true, "response" : { "page" : [ { "Invoice.CreatedDate" : "Dec 7, 2013 2:18:00 PM", "Account.Currency" : "USD", "Invoice.Amount" : "900.00", "BillToContact.AccountId" : "2c90838f42cf16030142cf215ecb0014" }, { "Invoice.CreatedDate" : "Nov 7, 2013 11:20:00 AM", "Account.Currency" : "USD", "Invoice.Amount" : "400.00", "BillToContact.AccountId" : "402892f9423062950142308c64e503f3" }, { "Invoice.CreatedDate" : "Jan 20, 2014 3:19:01 PM", "Account.Currency" : "EUR", "Invoice.Amount" : "984.00", "BillToContact.AccountId" : "8a858290439c517a0143b1edf32800ba" }, { "Invoice.CreatedDate" : "Jan 20, 2014 3:24:00 PM", "Account.Currency" : "CAD", "Invoice.Amount" : "1,729.76", "BillToContact.AccountId" : "8a858290439c517a0143b1f4229c013f" } ], "size" : 100, "offset" : 1, "total" : 4 } }
```

--------------------------------

### Get Age Buckets Response

Source: https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/age-bucket-settings/get-age-buckets

Example of a successful 200 response body containing the defined aging buckets.

```JSON
{ "includeNegativeInvoice": true, "buckets": [ { "name": "Current", "fromDaysPastDue": 0, "toDaysPastDue": 0 }, { "name": "1 to 30 days past due", "fromDaysPastDue": 1, "toDaysPastDue": 30 }, { "name": "31 to 60 days past due", "fromDaysPastDue": 31, "toDaysPastDue": 60 }, { "name": "61 to 90 days past due", "fromDaysPastDue": 61, "toDaysPastDue": 90 }, { "name": "91 to 120 days past due", "fromDaysPastDue": 91, "toDaysPastDue": 120 }, { "name": "more than 120 days past due", "fromDaysPastDue": 121, "toDaysPastDue": 151 } ] }
```
Tokens:
Raw