zuora.revenue
Module zuora.revenue
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_zuora.revenue_1.5.0.png)
ballerinax/zuora.revenue Ballerina library
Overview
This is a generated connector for [Zuora Revenue API V2021-08-12](https://www.zuora.com/developer/revpro-api/) OpenAPI specification. The Revenue API provides access to Zuroa revenue related operations on BI views, reports, revenue Jobs etc.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Zuora account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
zuora.revenue: Client![](/images/permalink.svg)
This is a generated connector for Zuora Revenue API V2021-08-12 OpenAPI specification. The Revenue API provides access to Zuroa revenue related operations on BI views, reports, revenue Jobs etc.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Zuora account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
getFileuploadstatus![](/images/permalink.svg)
Get file upload status
Parameters
- fileRequestId int - The request ID of the file upload to be queried.
Return Type
- json|error? - The status information is returned for the requested file upload.
getUploadstatus![](/images/permalink.svg)
Get upload status
Parameters
- id int - The request ID of the uploaded file for which the status information is being queried.
Return Type
- json|error - The status information is returned for the requested upload.
postUpload![](/images/permalink.svg)
Create upload
Parameters
- templatename string - The name of the upload template that you want to use.
- filename string - The unique file name to populate the data in the Zuora Revenue UI.
- payload string[] -
Return Type
- json|error - Data is uploaded to the staging tables in Zuora Revenue.
putTransferbatchstatus![](/images/permalink.svg)
Update transfer batch status
Parameters
- batchId int - The batch ID of the transfer accounting batch.
Return Type
- json|error - The status of the transfer batch is changed to
Transferred
.
getTransferbatch![](/images/permalink.svg)
Get transfer batch
Parameters
- batchid int - The batch ID of the transfer accounting batch.
- pagenum int - The number of page to be downloaded.
- pagesize int? (default ()) - The number of records to be downloaded per request. The default is 1000 and the maximum is 10000.
Return Type
- json|error - Operation is successful.
getBiviews![](/images/permalink.svg)
function getBiviews(string tmplName, int clientId, string fromDate, string toDate, int pagenum, int? pagesize, boolean count) returns Response|error
Get BI Views
Parameters
- tmplName string - Name of the BI view.
- clientId int - The ID of the Zuora Revenue application user.
- fromDate string - The date from which the data query begins.
- toDate string - The date on which the data query ends.
- pagenum int - The number of page to download.
- pagesize int? (default ()) - The number of records to be downloaded per request. The default is 1000 and the maximum is 10000.
- count boolean (default false) - Set to
true
to get the row count of the BI view for the specified time period. Note: Setting this parameter totrue
might cause timeout errors for large volume scenarios.
postBiviews![](/images/permalink.svg)
function postBiviews(string tmplName, int clientId, string fromDate, string toDate, int pagenum, string[] payload, boolean count) returns Response|error
Get BI View data for selected fields
Parameters
- tmplName string - Name of the BI view.
- clientId int - The ID of the Zuora Revenue application user.
- fromDate string - The date from which the data query begins.
- toDate string - The date on which the data query ends.
- pagenum int - The number of page to download.
- payload string[] -
- count boolean (default false) - Set to
true
to get the row count of the BI view for the specified time period. Note: Setting this parameter totrue
might cause timeout errors for large volume scenarios.
getTransferbatchlist![](/images/permalink.svg)
function getTransferbatchlist() returns json|error?
Get transfer batch list
Return Type
- json|error? - Operation is successful.
getTransferbatchfile![](/images/permalink.svg)
Get transfer batch file
Parameters
- batchId int - The batch ID of the transfer accounting batch.
Return Type
- json|error? - Operation is successful.
getReportlist![](/images/permalink.svg)
Get report list
Parameters
- createddate string? (default ()) - The date when reports are created.
Return Type
- json|error - Operation is successful.
getDownloadreports![](/images/permalink.svg)
Download a report
Parameters
- filename string - The name of the report file to be downloaded.
getReportsurl![](/images/permalink.svg)
Get report data
Parameters
- reportId int - The ID of the report to be downloaded. You can get the report ID in the <a href="https://www.zuora.com/developer/revpro-api/#operation/GET_ReportList">Get report list</a> response.
Return Type
- json|error - The URL to download the report file. The signed URL will be valid for 30 minutes from the time when it is generated.
getStaggingerror![](/images/permalink.svg)
Get staging error
Parameters
- errortype string - The type of errors that you want to retrieve.
Return Type
- json|error? - Staging errors of the specified type are returned.
getFileuploadmapping![](/images/permalink.svg)
Get field mapping
Parameters
- templatename string? (default ()) - Name of the upload template that contains the field mapping information.
Return Type
- json|error - Field mapping data is returned.
getAlltaskstatus![](/images/permalink.svg)
function getAlltaskstatus() returns json|error?
Get all task status
Return Type
- json|error? - The task details are returned.
getTaskdetails![](/images/permalink.svg)
Get active task details
Parameters
- taskId string - The continuation token that was returned in the initial request.
Return Type
- json|error? - The details of active tasks that are associated with the continuation token are returned.
deleteTask![](/images/permalink.svg)
Cancel task
Parameters
- taskId string - The continuation token that is associated with the tasks to be canceled.
Return Type
getRowcount![](/images/permalink.svg)
function getRowcount(string tmplName, int clientId, string fromDate, string toDate) returns Response|error
Get row count
Parameters
- tmplName string - Name of the BI view.
- clientId int - The ID of the Zuora Revenue application user.
- fromDate string (default "2016-07-26T00:00:00.000Z") - The date from which the data query begins.
- toDate string (default "2018-07-26T00:00:00.000Z") - The date on which the data query ends.
getBiview![](/images/permalink.svg)
function getBiview(string tmpleName, int clientId, string fromDate, string toDate, string? continuationToken, int pagenum, int? pageSize, string outputType) returns Response|error
Download BI view
Parameters
- tmpleName string - Name of the BI view.
- clientId int - The ID of the Zuora Revenue application user.
- fromDate string - The date from which the data query begins.
- toDate string - The date on which the data query ends.
- continuationToken string? (default ()) - The continuation token that was returned in the initial query for Page 1. Note: The continuation token is returned after Page 1 of the BI view is downloaded. To download the subsequent pages, you must specify the continuation token in this operation for Page 2 onwards.
- pagenum int (default 1) - The number of page to be downloaded.
- pageSize int? (default ()) - The number of rows on each page to be downloaded. * For CSV format, the valid range is 1 - 10,000 with default 10,000. * For gzip format, the valid range is 1 - 20,000 with default 20,000. Note: Any value that is greater than 20,000 is invalid.
- outputType string (default "gzip") - The output format of the download.
getColumnlist![](/images/permalink.svg)
Get column list
Parameters
- tmpleName string - Name of the BI view.
postCollection![](/images/permalink.svg)
function postCollection(RevenueJobRequest payload) returns RevenueJobResponse|error
Submit data collection job
Parameters
- payload RevenueJobRequest -
Return Type
- RevenueJobResponse|error - The request is submitted successfully and the job ID is returned. You can use the returned ID to query the job status later.
getCollectiondetails![](/images/permalink.svg)
function getCollectiondetails(int jobId) returns RevenueJobDetail|error
Get data collection job details
Parameters
- jobId int - The ID of the data collection job that you want to query. This is the ID that is returned when you submitted the data collection job.
Return Type
- RevenueJobDetail|error - The request is submitted successfully.
Records![](/images/permalink.svg)
zuora.revenue: Active![](/images/permalink.svg)
Fields
- accumulate int? -
- activity_tracker ActiveActivityTracker? -
- message string? -
- metric string? -
- query_config ActiveQueryConfig? -
- status string? -
- task_id string? -
zuora.revenue: ActiveActivityTracker![](/images/permalink.svg)
Fields
- elapsed_time string? -
- initated_time string? -
- last_activity string? -
zuora.revenue: ActiveQueryConfig![](/images/permalink.svg)
Fields
- filter_params ActiveQueryConfigFilterParams? -
- object_name string? -
zuora.revenue: ActiveQueryConfigFilterParams![](/images/permalink.svg)
Fields
- fromDate string? -
- toDate string? -
zuora.revenue: ActivityQueueStatus![](/images/permalink.svg)
Fields
- accumulate int? -
- activity_tracker ActivityqueuestatusActivityTracker? -
- message string? -
- metric int? -
- query_config ActivityqueuestatusQueryConfig? -
- status string? -
- task_id string? -
zuora.revenue: ActivityqueuestatusActivityTracker![](/images/permalink.svg)
Fields
- elapsed_time string? -
- initated_time string? -
- last_activity string? -
zuora.revenue: ActivityqueuestatusQueryConfig![](/images/permalink.svg)
Fields
- filter_param ActivityqueuestatusQueryConfigFilterParam? -
- object_name string? -
zuora.revenue: ActivityqueuestatusQueryConfigFilterParam![](/images/permalink.svg)
Fields
- fromDate string? -
- toDate string? -
zuora.revenue: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- token string - Represents API Key
token
zuora.revenue: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
zuora.revenue: Columns![](/images/permalink.svg)
Fields
- column_name string? -
- data_length int? -
- data_precision string? -
- data_scale string? -
- data_type string? -
zuora.revenue: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
zuora.revenue: Journal![](/images/permalink.svg)
Fields
- client_id int? -
- crtd_by string? -
- crtd_dt string? -
- id int? -
- name string? -
- status string? -
- updt_by string? -
- updt_dt string? -
- report_id int? -
zuora.revenue: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
zuora.revenue: ReportList![](/images/permalink.svg)
Fields
- category string? -
- file_name string? -
- id int? -
- layout_name string? -
- rep_desc string? -
- rep_name string? -
- report_date string? -
- status string? -
zuora.revenue: RevenueJobDetail![](/images/permalink.svg)
Fields
- data RevenuejobdetailData? -
- success boolean? -
zuora.revenue: RevenuejobdetailData![](/images/permalink.svg)
Fields
- actual_start_date string? -
- crtd_by string? -
- crtd_dt string? -
- id int? -
- status string? -
- updt_dt string? -
zuora.revenue: RevenueJobRequest![](/images/permalink.svg)
Fields
- rc_template_name string? - Name of the RC template that is defined in Zuora Revenue (Policies > RC Grouping Template).
- org_id int? - The organization ID that can be found in Zuora Revenue (Setups > Application > Organization). This field is required only for multi-organization tenants.
zuora.revenue: RevenueJobResponse![](/images/permalink.svg)
Fields
- message string? -
- success boolean? -
zuora.revenue: StageError![](/images/permalink.svg)
Fields
- client_id int? -
- crtd_by string? -
- crtd_dt string? -
- err_msg string? -
- id int? -
- inv_line_id string? -
- inv_line_num string? -
- processed_flag string? -
- sec_atr_val string? -
- so_line_id string? -
- so_line_num string? -
- so_num string? -
- 'type string? -
- updt_by string? -
- updt_dt string? -
- upload_id string? -
zuora.revenue: StatusTaskState![](/images/permalink.svg)
Fields
- accumulate int? -
- activity_tracker string[]? -
zuora.revenue: UploadMapping![](/images/permalink.svg)
Fields
- client_id int? -
- col_name string? -
- data_type string? -
- id int? -
- label string? -
- seq int? -
- upload_id int? -
zuora.revenue: UploadStatus![](/images/permalink.svg)
Fields
- file_log string? -
- file_request_id int? -
String types![](/images/permalink.svg)
Import
import ballerinax/zuora.revenue;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Finance/Accounting
Cost/Paid
Contributors
Dependencies