zuora.revenue
Module zuora.revenue
API
Definitions
ballerinax/zuora.revenue Ballerina library
Overview
Zuora Revenue is a revenue recognition and accounting automation application that ingests transaction data from source ERP systems, creates revenue contracts and produces accounting and reporting data.
The Zuora Revenue connector lets Ballerina applications use the Zuora Revenue REST API to authenticate, upload transaction and event data, track uploads and staging errors, transfer accounting batches, download BI view data and reports, and submit and monitor revenue programs and data collection jobs. It supports version 2025-08-06 of the Zuora Revenue REST API.
Key features
- Authenticate against Zuora Revenue and obtain the token used by the other operations
- Upload transaction, event and bundle configuration data as CSV files, and track upload status and staging errors
- List and update accounting transfer batches and download their files
- Query BI views, monitor their download tasks and list generated reports with signed download URLs
- Submit revenue programs and data collection jobs, and monitor the resulting jobs
Setup guide
To use the Zuora Revenue connector, you need a Zuora Revenue tenant and an API user.
-
Ask your Zuora Revenue administrator to create a user that has an API role, for example
API Role, and note the username, password, role name and client name. -
Note the host of your Zuora Revenue tenant. The connector's service URL is
https://<host>/api/integration. -
Call the Authentication operation with the username and password as HTTP basic credentials. The connector sends the credentials as basic authentication and the response contains the token that the other operations take in their
tokenheader. A token is valid for 30 minutes by default; call the operation again to get a new one.
Quickstart
To use the zuora.revenue connector in your Ballerina application, modify the .bal file as follows.
Step 1: Import the module
import ballerinax/zuora.revenue;
Step 2: Instantiate a new connector
Create a Config.toml file with your credentials and service URL.
username = "<username>" password = "<password>" role = "<role>" clientName = "<client-name>" serviceUrl = "https://<host>/api/integration"
Then create the client.
configurable string username = ?; configurable string password = ?; configurable string role = ?; configurable string clientName = ?; configurable string serviceUrl = ?; final revenue:Client revenueClient = check new ({auth: {username, password}}, serviceUrl);
Step 3: Invoke the connector operation
public function main() returns error? { revenue:AuthenticationResponse _ = check revenueClient->createAuthentication({role, clientname: clientName}); }
Step 4: Run the Ballerina application
bal run
Examples
The Zuora Revenue connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Report signed URLs - List the reports created on a date and fetch a signed download URL for each.
- Revenue program run - Confirm a revenue program exists, submit it and poll the resulting job until it finishes.
Clients
zuora.revenue: Client
This is the client for the Zuora Revenue REST API, used to upload data, track uploads and staging errors, download BI view data and reports, transfer accounting batches, and submit and monitor revenue programs and data collection jobs.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://yourHost/api/integration" - URL of the target service
createAuthentication
function createAuthentication(CreateAuthenticationHeaders headers) returns AuthenticationResponse|errorCreate authentication
Parameters
- headers CreateAuthenticationHeaders (default {}) - Headers to be sent with the request
Return Type
- AuthenticationResponse|error - Authentication token is returned
getFileUploadStatus
function getFileUploadStatus(int fileRequestId, GetFileUploadStatusHeaders headers) returns FileUploadStatusResponse|error?Get file upload status
Parameters
- fileRequestId int - The request ID of the file upload to be queried
- headers GetFileUploadStatusHeaders - Headers to be sent with the request
Return Type
- FileUploadStatusResponse|error? - The status information is returned for the requested file upload
uploadFile
function uploadFile(UploadFileHeaders headers, UploadFileBody payload) returns UploadFileResponse|errorUpload file
Parameters
- headers UploadFileHeaders - Headers to be sent with the request
- payload UploadFileBody - Multipart form with the CSV file to upload and its upload options
Return Type
- UploadFileResponse|error - The file is uploaded to Zuora Revenue
getUploadStatus
function getUploadStatus(GetUploadStatusHeaders headers, *GetUploadStatusQueries queries) returns UploadStatusResponse|errorGet upload status
Parameters
- headers GetUploadStatusHeaders - Headers to be sent with the request
- queries *GetUploadStatusQueries - Queries to be sent with the request
Return Type
- UploadStatusResponse|error - The status information is returned for the requested upload
createUpload
function createUpload(CreateUploadHeaders headers, string payload) returns CreateUploadResponse|errorCreate upload
Parameters
- headers CreateUploadHeaders - Headers to be sent with the request
- payload string - CSV lines of transaction, event or bundle configuration data to upload
Return Type
- CreateUploadResponse|error - Data is uploaded to the staging tables in Zuora Revenue
updateTransferBatchStatus
function updateTransferBatchStatus(int batchId, UpdateTransferBatchStatusHeaders headers) returns TransferBatchStatusResponse|errorUpdate transfer batch status
Parameters
- batchId int - The batch ID of the transfer accounting batch
- headers UpdateTransferBatchStatusHeaders - Headers to be sent with the request
Return Type
- TransferBatchStatusResponse|error - The status of the transfer batch is changed to
Transferred
getTransferBatch
function getTransferBatch(int batchid, int pagenum, GetTransferBatchHeaders headers, *GetTransferBatchQueries queries) returns TransferBatchStatusResponse|errorGet transfer batch
Parameters
- batchid int - The batch ID of the transfer accounting batch
- pagenum int - The number of page to be downloaded
- headers GetTransferBatchHeaders - Headers to be sent with the request
- queries *GetTransferBatchQueries - Queries to be sent with the request
Return Type
- TransferBatchStatusResponse|error - The GL transfer batch data for the requested batch ID and page is returned
getBiViews
function getBiViews(string viewName, GetBiViewsHeaders headers, *GetBiViewsQueries queries) returns byte[]|error?Get BI Views
Parameters
- viewName string - Name of the BI view
- headers GetBiViewsHeaders - Headers to be sent with the request
- queries *GetBiViewsQueries - Queries to be sent with the request
Return Type
- byte[]|error? - BI view data is returned in CSV format
getBiViewsForFields
function getBiViewsForFields(string viewName, GetBiViewsForFieldsHeaders headers, string[] payload, *GetBiViewsForFieldsQueries queries) returns byte[]|error?Get BI View data for selected fields
Parameters
- viewName string - Name of the BI view
- headers GetBiViewsForFieldsHeaders - Headers to be sent with the request
- payload string[] - List of field names to be selected from the BI view
- queries *GetBiViewsForFieldsQueries - Queries to be sent with the request
Return Type
- byte[]|error? - BI view data is returned in CSV format
listTransferBatches
function listTransferBatches(ListTransferBatchesHeaders headers) returns TransferBatchListResponse|error?Get transfer batch list
Parameters
- headers ListTransferBatchesHeaders - Headers to be sent with the request
Return Type
- TransferBatchListResponse|error? - The list of available transfer accounting batches is returned
getTransferBatchFile
function getTransferBatchFile(int batchId, GetTransferBatchFileHeaders headers) returns TransferBatchFileResponse|error?Get transfer batch file
Parameters
- batchId int - The batch ID of the transfer accounting batch
- headers GetTransferBatchFileHeaders - Headers to be sent with the request
Return Type
- TransferBatchFileResponse|error? - The GL transfer batch file for the requested batch ID is returned
listReports
function listReports(ListReportsHeaders headers, *ListReportsQueries queries) returns ReportListResponse|errorGet report list
Parameters
- headers ListReportsHeaders - Headers to be sent with the request
- queries *ListReportsQueries - Queries to be sent with the request
Return Type
- ReportListResponse|error - The list of reports created on the specified date is returned
downloadReport
function downloadReport(string filename, DownloadReportHeaders headers) returns byte[]|error?Download a report
Parameters
- filename string - The name of the report file to be downloaded
- headers DownloadReportHeaders - Headers to be sent with the request
Return Type
- byte[]|error? - The report file is returned
getReportSignedUrl
function getReportSignedUrl(int reportId, GetReportSignedUrlHeaders headers) returns ReportSignedUrlResponse|errorGet report signed URL
Parameters
- reportId int - The ID of the report to be downloaded. You can get the report ID in the (Get report list)[/other-api/revenue/operation/GET_ReportList] response
- headers GetReportSignedUrlHeaders - Headers to be sent with the request
Return Type
- ReportSignedUrlResponse|error - The URL to download the report file. The signed URL will be valid for 30 minutes from the time when it is generated
getStagingErrors
function getStagingErrors("transaction"|"event" errortype, GetStagingErrorsHeaders headers) returns StagingErrorResponse|error?Get staging error
Parameters
- errortype "transaction"|"event" - The type of errors that you want to retrieve
- headers GetStagingErrorsHeaders - Headers to be sent with the request
Return Type
- StagingErrorResponse|error? - Staging errors of the specified type are returned
getFieldMapping
function getFieldMapping(GetFieldMappingHeaders headers, *GetFieldMappingQueries queries) returns FieldMappingResponse|errorGet field mapping
Parameters
- headers GetFieldMappingHeaders - Headers to be sent with the request
- queries *GetFieldMappingQueries - Queries to be sent with the request
Return Type
- FieldMappingResponse|error - Field mapping data is returned
listBiViewTasks
function listBiViewTasks(ListBiViewTasksHeaders headers) returns BiViewTaskListResponse|error?Get all BI view task status
Parameters
- headers ListBiViewTasksHeaders - Headers to be sent with the request
Return Type
- BiViewTaskListResponse|error? - The task details are returned
getBiViewTask
function getBiViewTask(string taskId, GetBiViewTaskHeaders headers) returns BiViewTaskDetailsResponse|error?Get active task details
Parameters
- taskId string - The continuation token that was returned in the initial request
- headers GetBiViewTaskHeaders - Headers to be sent with the request
Return Type
- BiViewTaskDetailsResponse|error? - The details of active tasks that are associated with the continuation token are returned
cancelBiViewTask
function cancelBiViewTask(string taskId, CancelBiViewTaskHeaders headers) returns error?Cancel BI view download tasks
Parameters
- taskId string - The continuation token that is associated with the tasks to be canceled
- headers CancelBiViewTaskHeaders - Headers to be sent with the request
Return Type
- error? - The tasks associated with the specified continuation token are canceled
getBiViewRowCount
function getBiViewRowCount(string tmplName, GetBiViewRowCountHeaders headers, *GetBiViewRowCountQueries queries) returns record {}|errorGet BI view row count
Parameters
- tmplName string - Name of the BI view
- headers GetBiViewRowCountHeaders - Headers to be sent with the request
- queries *GetBiViewRowCountQueries - Queries to be sent with the request
Return Type
- record {}|error - The row count of the specified BI view is returned
downloadBiView
function downloadBiView(string viewName, DownloadBiViewHeaders headers, *DownloadBiViewQueries queries) returns byte[]|error?Download BI view
Parameters
- viewName string - Name of the BI view
- headers DownloadBiViewHeaders - Headers to be sent with the request
- queries *DownloadBiViewQueries - Queries to be sent with the request
Return Type
- byte[]|error? - The queried BI view data is returned as a CSV or gzip file
listBiViewColumns
function listBiViewColumns(string tmplName, ListBiViewColumnsHeaders headers) returns record {}|errorGet column list
Parameters
- tmplName string - Name of the BI view
- headers ListBiViewColumnsHeaders - Headers to be sent with the request
Return Type
- record {}|error - The list of columns is returned for the requested BI view
createCollectionJob
function createCollectionJob(RevenueJobRequest payload, map<string|string[]> headers) returns RevenueJobResponse|errorSubmit data collection job
Parameters
- payload RevenueJobRequest - Data collection job request based on a revenue collection template
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
getCollectionJob
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 status of the data collection job is returned
listPrograms
function listPrograms(map<string|string[]> headers) returns ProgramDetailsResponse|errorGet list of available programs and program parameters
Return Type
- ProgramDetailsResponse|error - A list of available programs is returned
listRevenueOrgs
function listRevenueOrgs(map<string|string[]> headers) returns ProgramDetailsResponse|errorGet list of available organizations
Return Type
- ProgramDetailsResponse|error - A list of available organizations is returned
submitProgram
function submitProgram(int programId, int orgId, SubmitJobRequest payload, map<string|string[]> headers) returns JobStatusResponse|errorSubmit a program with specified parameters
Parameters
- programId int - The ID of the program that is to be submitted in Zuora Revenue. You can get the program ID by using the "Get list of available programs and program parameters" operation
- orgId int - The ID of the organization for which the program is to be submitted. You can get the organization ID by using the "Get list of available organizations" operation
- payload SubmitJobRequest - An array that contains the parameter values to be used for the program. For each parameter, you need to specify the parameter ID, sequence, and desired value
Return Type
- JobStatusResponse|error - The job status is returned with the job ID
getJobStatus
function getJobStatus(int jobId, int orgId, map<string|string[]> headers) returns JobStatusResponse|errorGet the job status
Parameters
- jobId int - The ID of the Zuora Revenue job whose status is queried. This is the job ID returned when the program was submitted
- orgId int - The ID of the organization that is specified when the job is submitted
Return Type
- JobStatusResponse|error - The job status is returned
Records
zuora.revenue: ActiveActivityTracker
Fields
- initatedTime? string -
- lastActivity? string -
- elapsedTime? string -
zuora.revenue: ActiveQueryConfig
Fields
- objectName? string -
- filterParams? ActiveQueryConfigFilterParams -
zuora.revenue: ActiveQueryConfigFilterParams
Fields
- fromDate? string -
- toDate? string -
zuora.revenue: ActiveTasks
Fields
- activityTracker? ActiveActivityTracker -
- metric? string -
- accumulate? int -
- queryConfig? ActiveQueryConfig -
- taskId? string -
- message? string -
- status? string -
zuora.revenue: ActivityQueueStatus
Fields
- activityTracker? ActivityQueueStatusActivityTracker -
- metric? int -
- accumulate? int -
- queryConfig? ActivityQueueStatusQueryConfig -
- taskId? string -
- message? string -
- status? string -
zuora.revenue: ActivityQueueStatusActivityTracker
Fields
- initatedTime? string -
- lastActivity? string -
- elapsedTime? string -
zuora.revenue: ActivityQueueStatusQueryConfig
Fields
- filterParam? ActivityQueueStatusQueryConfigFilterParam -
- objectName? string -
zuora.revenue: ActivityQueueStatusQueryConfigFilterParam
Fields
- fromDate? string -
- toDate? string -
zuora.revenue: AuthenticationResponse
Fields
- Message string(default "Token Generated") - Token
- status string(default "success") - Response Status
zuora.revenue: BiViewTaskDetailsResponse
Fields
- active? ActiveTasks[] -
- completed? CompletedTasks[] -
- draining? DrainingTasks[] -
- stale? StaleTasks[] -
zuora.revenue: BiViewTaskListResponse
Fields
- result? BiViewTaskListResult -
- status string(default "Success") - Response Status
zuora.revenue: BiViewTaskListResult
Fields
- stale? ActivityQueueStatus[] -
- draining? ActivityQueueStatus[] -
- active? ActivityQueueStatus[] -
- completed? ActivityQueueStatus[] -
zuora.revenue: CancelBiViewTaskHeaders
Represents the Headers record for the operation: cancelBiViewTask
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - 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
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
zuora.revenue: CreateAuthenticationHeaders
Represents the Headers record for the operation: createAuthentication
Fields
- role string(default "API Role") - The Zuora Revenue user role that the token is generated for, for example the API role
- clientname string(default "Default") - The name of the client (application) that connects to Zuora Revenue
zuora.revenue: CreateUploadHeaders
Represents the Headers record for the operation: createUpload
Fields
- filename string - The unique file name to populate the data in the Zuora Revenue UI
- templatename string - The name of the upload template that you want to use
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: CreateUploadResponse
Fields
- message string(default "Data Staged Successfully") - Response Message
- result? CreateUploadResult -
- status string(default "Success") - Response Status
zuora.revenue: CreateUploadResult
Fields
- id? int -
- message? string -
- clientId? int -
- status? string -
zuora.revenue: DownloadBiViewHeaders
Represents the Headers record for the operation: downloadBiView
Fields
- continuationToken? string - 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
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: DownloadBiViewQueries
Represents the Queries record for the operation: downloadBiView
Fields
- fromDate string(default "2016-07-26T00:00:00") - The date from which the data query begins
- clientId int(default 1) - The ID of the Zuora Revenue application user
- toDate string(default "2018-07-26T00:00:00") - The date on which the data query ends
- pageSize? int - The number of rows on each page to be downloaded.
- For CSV format, the valid range is 1 - 10,000 with default 1,000.
- For gzip format, the valid range is 1 - 20,000 with default 1,000.
- outputType "csv"|"gzip" (default "gzip") - The output format of the download
- pagenum int(default 1) - The number of page to be downloaded
zuora.revenue: DownloadReportHeaders
Represents the Headers record for the operation: downloadReport
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: FieldMappingResponse
Fields
- Dateformat string(default "DD-MON-YYYY") - Response Status
- Mapping? UploadMapping[] -
zuora.revenue: FileUploadStatusResponse
Fields
- Result? UploadStatus[] -
- message string(default "Data Staged Successfully") - Response Message
- status string(default "Success") - Response Status
zuora.revenue: GetBiViewRowCountHeaders
Represents the Headers record for the operation: getBiViewRowCount
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetBiViewRowCountQueries
Represents the Queries record for the operation: getBiViewRowCount
Fields
- fromDate string(default "2016-07-26T00:00:00") - The date from which the data query begins
- clientId int(default 1) - The ID of the Zuora Revenue application user
- toDate string(default "2018-07-26T00:00:00") - The date on which the data query ends
zuora.revenue: GetBiViewsForFieldsHeaders
Represents the Headers record for the operation: getBiViewsForFields
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetBiViewsForFieldsQueries
Represents the Queries record for the operation: getBiViewsForFields
Fields
- fromDate string(default "2016-07-26T00:00:00") - The date from which the data query begins
- clientId int(default 1) - The ID of the Zuora Revenue application user
- toDate string(default "2016-07-26T00:00:00") - The date on which the data query ends
- count? boolean - Set to
trueto get the row count of the BI view for the specified time period. Note: Setting this parameter totruemight cause timeout errors for large volume scenarios
- pagenum int(default 1) - The number of page to download
zuora.revenue: GetBiViewsHeaders
Represents the Headers record for the operation: getBiViews
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetBiViewsQueries
Represents the Queries record for the operation: getBiViews
Fields
- fromDate string(default "2016-07-26T00:00:00") - The date from which the data query begins
- clientId int(default 1) - The ID of the Zuora Revenue application user
- toDate string(default "2016-07-26T00:00:00") - The date on which the data query ends
- pagesize? int - The number of records to be downloaded per request. The default is 1000 and the maximum is 10000
- count? boolean - Set to
trueto get the row count of the BI view for the specified time period. Note: Setting this parameter totruemight cause timeout errors for large volume scenarios
- pagenum int(default 1) - The number of page to download
zuora.revenue: GetBiViewTaskHeaders
Represents the Headers record for the operation: getBiViewTask
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetFieldMappingHeaders
Represents the Headers record for the operation: getFieldMapping
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetFieldMappingQueries
Represents the Queries record for the operation: getFieldMapping
Fields
- templatename? string - Name of the upload template that contains the field mapping information
zuora.revenue: GetFileUploadStatusHeaders
Represents the Headers record for the operation: getFileUploadStatus
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetReportSignedUrlHeaders
Represents the Headers record for the operation: getReportSignedUrl
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetStagingErrorsHeaders
Represents the Headers record for the operation: getStagingErrors
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetTransferBatchFileHeaders
Represents the Headers record for the operation: getTransferBatchFile
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetTransferBatchHeaders
Represents the Headers record for the operation: getTransferBatch
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetTransferBatchQueries
Represents the Queries record for the operation: getTransferBatch
Fields
- pagesize? int - The number of records to be downloaded per request. The default is 1000 and the maximum is 10000
zuora.revenue: GetUploadStatusHeaders
Represents the Headers record for the operation: getUploadStatus
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: GetUploadStatusQueries
Represents the Queries record for the operation: getUploadStatus
Fields
- id int - The request ID of the uploaded file for which the status information is being queried
zuora.revenue: JobStatus
Fields
- errorMessage? string -
- crtdDt? string -
- actualStartDate? string -
- crtdBy? string -
- id? int -
- updtDt? string -
- secAtrVal? int -
- status? string -
zuora.revenue: JobStatusResponse
Fields
- data? JobStatus -
- success? boolean -
zuora.revenue: Journal
Fields
- crtdDt? string -
- updtBy? string -
- crtdBy? string -
- reportId? Signed32 -
- name? string -
- id? Signed32 -
- updtDt? string -
- clientId? int -
- status? string -
zuora.revenue: ListBiViewColumnsHeaders
Represents the Headers record for the operation: listBiViewColumns
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: ListBiViewTasksHeaders
Represents the Headers record for the operation: listBiViewTasks
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: ListReportsHeaders
Represents the Headers record for the operation: listReports
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: ListReportsQueries
Represents the Queries record for the operation: listReports
Fields
- createddate? string - The date when reports are created
zuora.revenue: ListTransferBatchesHeaders
Represents the Headers record for the operation: listTransferBatches
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: ParameterList
Fields
- sequence int(default 1) -
- parameterValue? string -
- parameterId int(default 1002) -
zuora.revenue: ProgramDetail
Fields
- programName? string -
- programId? string -
- parameters? ProgramParameter[] -
zuora.revenue: ProgramDetailsResponse
Fields
- data? ProgramDetail[] -
zuora.revenue: ProgramParameter
Fields
- sequence? string -
- name? string -
- id? int -
- 'type? string -
- mandatory? string -
zuora.revenue: ReportList
Fields
- repDesc? string -
- layoutName? string -
- repName? string -
- fileName? string -
- id? int -
- category? string -
- reportDate? string -
- status? string -
zuora.revenue: ReportListResponse
Fields
- Message? string - Response Message
- Result? ReportList[] -
- status string(default "Success") - Response Status
zuora.revenue: ReportSignedUrlResponse
Fields
- signed_url? anydata - A valid signed URL to download the report.
- success? boolean - Indicates whether the operation succeeded.
zuora.revenue: RevenueJobDetail
Fields
- data? RevenueJobDetailData -
- success? boolean -
zuora.revenue: RevenueJobDetailData
Fields
- crtdDt? string -
- actualStartDate? string -
- crtdBy? string -
- id? int -
- updtDt? string -
- status? "Running"|"Error"|"Pending"|"Completed"|"Warning"|"Failed"|"Cancelled"|"Terminated"|"Incompatible" -
zuora.revenue: RevenueJobRequest
Fields
- rc_template_name? string - Name of the RC template that is defined in Zuora Revenue (Policies > RC Grouping Template).
- org_id int(default 0) - 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
Fields
- message? string -
- success? boolean -
zuora.revenue: StageError
Fields
- processedFlag? string -
- uploadId? string -
- updtBy? string -
- soNum? string -
- soLineId? string -
- soLineNum? string -
- updtDt? string -
- 'type? string -
- secAtrVal? string -
- clientId? int -
- crtdDt? string -
- crtdBy? string -
- errMsg? string -
- invLineNum? string -
- invLineId? string -
- id? int -
zuora.revenue: StagingErrorResponse
Fields
- Result? StageError[] -
- status string(default "Success") - Response Status
zuora.revenue: SubmitJobRequest
Fields
- parameters? ParameterList[] -
zuora.revenue: TransferBatchFileResponse
Fields
- active? anydata[] - Response Status
zuora.revenue: TransferBatchListResponse
Fields
- result? Journal[] -
- status string(default "Success") - Response Status
zuora.revenue: TransferBatchStatusResponse
Fields
- status string(default "Success") - Response Status
zuora.revenue: UpdateTransferBatchStatusHeaders
Represents the Headers record for the operation: updateTransferBatchStatus
Fields
- token string - The valid authentication token that is generated by the Authentication operation
zuora.revenue: UploadFileBody
Fields
- file record { fileContent byte[], fileName string } - The path to the CSV file that is to be uploaded
zuora.revenue: UploadFileHeaders
Represents the Headers record for the operation: uploadFile
Fields
- templatename string - Name of the upload template that you want to use
- token string - The valid authentication token that is generated by the Authentication operation
- contentType "multipart/form-data" - Must be set to "multipart/form-data"
zuora.revenue: UploadFileResponse
Fields
- message string(default "File received successfully") - Response Message
- status string(default "Success") - Response Status
zuora.revenue: UploadMapping
Fields
- uploadId? int -
- dataType? string -
- colName? string -
- id? int -
- label? string -
- clientId? int -
- seq? int -
zuora.revenue: UploadStatus
Fields
- fileRequestId? int -
- fileLog? string -
zuora.revenue: UploadStatusResponse
Fields
- result? UploadStatusResult -
- status string(default "Success") - Response Response
zuora.revenue: UploadStatusResult
Fields
- id? int -
- message string(default "Data Received") -
- clientId? int -
- status string(default "Successfully Uploaded") -
String types
Import
import ballerinax/zuora.revenue;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 43
Current verison: 1
Weekly downloads
Keywords
Vendor/Zuora
Area/Finance & Accounting
Type/Connector
Contributors