Module zuora.collection
ballerinax/zuora.collection Ballerina library
1.5.1
Overview
This is a generated connector for [Zuora Collections API V1](https://www.zuora.com/developer/collect-api/#) OpenAPI specification. This Zuora Collections API provides detailed descriptions about functions, requests, and responses of the APIs for the following four component apps. - Advanced Payment Manager - Collections Window - Configurable Payment Retry - Statement Generator
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Zuora account
- Obtain tokens by following this guide
Clients
zuora.collection: Client
Isolated
This is a generated connector for Zuora Collections API V1 OpenAPI specification. This reference provides detailed descriptions about functions, requests, and responses of the APIs for the following two component apps. Rest APIs for other component apps will be included in this reference when they are released.
- Advanced Payment Manager
- Collections Window
- Configurable Payment Retry
- Statement Generator
Constructor
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 (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getPaymentRun
Isolated FunctionRemote Function
function getPaymentRun(int paymentRunId) returns GETPaymentRunResponse|errorGet a payment run
Parameters
- paymentRunId int - The payment run ID. A payment run id in Advanced Payment Manager is different from a payment run id in Zuora.
createPaymentRun
Isolated FunctionRemote Function
function createPaymentRun(POSTPaymentRun payload) returns POSTPaymentRunResponse|errorCreate a payment run
Parameters
- payload POSTPaymentRun -
getPaymentRunSchedules
Isolated FunctionRemote Function
function getPaymentRunSchedules() returns GETPaymentRunSchedulesResponse|errorGet all payment run schedules
createPaymentRunSchedule
Isolated FunctionRemote Function
function createPaymentRunSchedule(POSTPaymentRunSchedule payload) returns POSTPaymentRunScheduleResponse|errorCreate a payment run schedule
Parameters
- payload POSTPaymentRunSchedule -
getPaymentRunSchedule
Isolated FunctionRemote Function
function getPaymentRunSchedule(int scheduleId) returns GETPaymentRunScheduleResponse|errorGet a payment run schedule
Parameters
- scheduleId int - The schedule ID
updatePaymentRunSchedule
Isolated FunctionRemote Function
function updatePaymentRunSchedule(int scheduleId, PUTPaymentRunSchedule payload) returns POSTPaymentRunScheduleResponse|errorUpdate a payment run schedule
deletePaymentRunSchedule
Isolated FunctionRemote Function
function deletePaymentRunSchedule(int scheduleId) returns DELETEPaymentRunScheduleResponse|errorCancel a payment run schedule
Parameters
- scheduleId int - The schedule ID
getStatement
Isolated FunctionRemote Function
Get a statement
Parameters
- statementNumber int - The statement number
getStatements
Isolated FunctionRemote Function
function getStatements(int accountId, int count) returns GETStatementsResponse|errorGet multiple statements
Parameters
- accountId int - The ID of the account
- count int - The number of statements you want to retrieve.
getSettings
Isolated FunctionRemote Function
function getSettings() returns GETStatementSettingsResponse|errorGet Statement Generator settings
createAdhocStatementRun
Isolated FunctionRemote Function
function createAdhocStatementRun(POSTAdhocStatementRun payload) returns POSTAdhocStatementRunResponse|errorCreate an ad hoc statement run
Parameters
- payload POSTAdhocStatementRun -
createCustomStatementRun
Isolated FunctionRemote Function
function createCustomStatementRun(POSTCustomStatementRun payload) returns POSTCustomStatementRunResponse|errorCreate a custom statement run
Parameters
- payload POSTCustomStatementRun -
getAccount
Isolated FunctionRemote Function
function getAccount(string accountId) returns CollectionAccount|errorGet an account
Parameters
- accountId string - The account ID.
getAccounts
Isolated FunctionRemote Function
function getAccounts() returns GETCollectionAccountsResponse|errorGet all accounts
getCollectionsAgent
Isolated FunctionRemote Function
function getCollectionsAgent(string email) returns CollectionAgent|errorGet a collections agent by email
Parameters
- email string - The email of the collections agent.
getCollectionsAgents
Isolated FunctionRemote Function
function getCollectionsAgents() returns GETCollectionAgentsResponse|errorGet all collections agents
getCollectionsInfo
Isolated FunctionRemote Function
function getCollectionsInfo() returns CollectionsInfo|errorGet an overview of collections
updateAccount
Isolated FunctionRemote Function
function updateAccount(string accountId, string status, boolean? value) returns InlineResponse200|errorUpdate account status
Parameters
- accountId string - The account ID.
- status string - The status that you want to update for the specified account.
- value boolean? (default ()) - The new value of the status. 0 indicates false, while 1 indicates true.
updateAccountAgent
Isolated FunctionRemote Function
function updateAccountAgent(string accountId, string agentEmail) returns InlineResponse200|errorUpdate account agent
getActiveInvoiceCycle
Isolated FunctionRemote Function
function getActiveInvoiceCycle(string invoiceId) returns GETActiveInvoiceCycleResponse|errorGet active retry cycles for an invoice
Parameters
- invoiceId string - ID of an invoice.
getActiveDebitMemoCycle
Isolated FunctionRemote Function
function getActiveDebitMemoCycle(string debitMemoId) returns GETActiveDebitMemoCycleResponse|errorGet active retry cycles for a debit memo
Parameters
- debitMemoId string - ID of a debit memo.
getActiveAccountCycle
Isolated FunctionRemote Function
function getActiveAccountCycle(string accountId) returns GETActiveAccountCycleResponse|errorGet active retry cycles for an account
Parameters
- accountId string - ID of an account.
getInvoiceCycleHistory
Isolated FunctionRemote Function
function getInvoiceCycleHistory(string invoiceId) returns GETInvoiceCycleHistoryResponse|errorGet retry cycle history for an invoice
Parameters
- invoiceId string - ID of an invoice.
getDebitMemoCycleHistory
Isolated FunctionRemote Function
function getDebitMemoCycleHistory(string debitMemoId) returns GETDebitMemoCycleHistoryResponse|errorGet retry cycle history for a debit memo
Parameters
- debitMemoId string - ID of a debit memo.
getAccountCycleHistory
Isolated FunctionRemote Function
function getAccountCycleHistory(string accountId) returns GETAccountCycleHistoryResponse|errorGet retry cycle history for an account
Parameters
- accountId string - ID of an account.
executeExecuteInvoicePayment
Isolated FunctionRemote Function
function executeExecuteInvoicePayment(string invoiceId) returns InlineResponse2001|errorExecute invoice payment
Parameters
- invoiceId string - ID of an invoice.
executeExecuteDebitMemoPayment
Isolated FunctionRemote Function
function executeExecuteDebitMemoPayment(string debitMemoId) returns InlineResponse2002|errorExecute debit memo payment
Parameters
- debitMemoId string - ID of a debit memo.
executeExecuteAccountPayments
Isolated FunctionRemote Function
function executeExecuteAccountPayments(string accountId) returns InlineResponse2003|errorExecute account payments
Parameters
- accountId string - ID of an account.
updateExecutePayments
Isolated FunctionRemote Function
function updateExecutePayments(PaymentsExecutePaymentsBody payload) returns InlineResponse2004|errorExecute payments
Parameters
- payload PaymentsExecutePaymentsBody -
removeRemoveInoviceFromCycle
Isolated FunctionRemote Function
function removeRemoveInoviceFromCycle(string invoiceId) returns InlineResponse2005|errorRemove an invoice from retry cycle
Parameters
- invoiceId string - ID of an invoice.
removeDebitMemoFromCycle
Isolated FunctionRemote Function
function removeDebitMemoFromCycle(string debitMemoId) returns InlineResponse2006|errorRemove a debit memo from retry cycle
Parameters
- debitMemoId string - ID of a debit memo.
removeAccountFromCycle
Isolated FunctionRemote Function
function removeAccountFromCycle(string accountId) returns InlineResponse2007|errorRemove an account from retry cycle
Parameters
- accountId string - ID of an account.
updateSubmitPaymentToCycle
Isolated FunctionRemote Function
function updateSubmitPaymentToCycle(PaymentsSubmitFailedPaymentBody payload) returns InlineResponse2008|errorSubmit a payment to retry cycle
Parameters
- payload PaymentsSubmitFailedPaymentBody -
getBaselineMetrics
Isolated FunctionRemote Function
function getBaselineMetrics() returns GETBaselineMetricsResponse|errorGet baseline metrics
getAmountRecovered
Isolated FunctionRemote Function
function getAmountRecovered() returns GETAmountRecoveredResponse|errorGet the Amount Recovered metrics
getDocumentSuccessRateByCustomerGroup
Isolated FunctionRemote Function
function getDocumentSuccessRateByCustomerGroup() returns GETDocumentSuccessRateByCustomerGroupResponse|errorGet the Document Success Rate metrics by customer group
getCustomerGroupMetrics
Isolated FunctionRemote Function
function getCustomerGroupMetrics() returns GETCustomerGroupMetricsResponse|errorGet the Customer Group metrics
Records
zuora.collection: ClientHttp1Settings
Closed record
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.collection: CollectionAccount
Fields
- name string? - The name of the account.
- zuora_id string? - The Zuora ID of the account.
- in_collections boolean? - Whether the account is in collections.
- account_currency string? - The currency that is currently used by the account.
- home_currency string? - The home currency of the tenant.
- amount_due_account_currency decimal? - The amount that is due for the account in the account currency.
- amount_due_home_currency decimal? - The amount that is due for the account in the tenant home currency.
- last_open_invoice_date string? - The last open invoice date.
- average_debt_age decimal? - The average age of all the debt of the account.
- statuses CollectionStatuses? - The status of the account.
zuora.collection: CollectionAgent
Fields
- name string? - The name of the agent.
- email string? - The email of the agent.
- zuora_identity_id string? - The Zuora ID of the agent.
- amount_in_collections decimal? - The total amount of debt for accounts that are assigned to the user.
- accounts int? - The number of accounts that are assigned to the user.
- account_statuses CollectionagentAccountStatuses? -
zuora.collection: CollectionagentAccountStatuses
Fields
- 'In\ Collections int? - The number of accounts that are in collections.
- Pending int? - The number of accounts that are pending.
- 'In\ Disputes int? - The number of accounts that are in dispute.
- 'Paid\ in\ Full int? - The number of accounts that have paid in full.
zuora.collection: CollectionsInfo
Fields
- accounts_in_collections int? - The number of accounts that are in collections.
- home_currency string? - The home currency of the tenant.
- total_debt decimal? - The total debt of all accounts that are in collections.
- largest_debts string[]? - The five largest debts that are in collections.
- oldest_debts string[]? - The five oldest debts that are in collections.
- statuses CollectionsinfoStatuses? -
zuora.collection: CollectionsinfoStatuses
Fields
- 'In\ Collection int? - The number of accounts that are in collections.
- Pending int? - The number of accounts that are in pending status.
- 'In\ Dispute int? - The number of accounts that are in dispute.
- 'Paid\ In\ Full int? -
zuora.collection: CollectionStatuses
The status of the account.
Fields
- 'In\ Collections boolean? - Whether this account is in collections.
- Pending boolean? - Whether this account is pending.
- 'In\ Dispute boolean? - Whether this account is in dispute.
- 'Paid\ In\ Full boolean? - Whether this account has paid in full.
zuora.collection: ConnectionConfig
Closed record
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? - 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-forwardedheader
- 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.collection: CustomerGroups
Fields
- id int? -
- name string? -
- smart_retry string? -
- document_success_rate string? -
- document_success_rate_trend string? -
- retry_success_rate string? -
- average_attempts string? -
zuora.collection: DELETEPaymentRunScheduleResponse
Fields
- success boolean? - Whether the operation is successful.
- errors string[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: GETAccountCycleElementResponse
Fields
- account_id string? - The ID of the customer account.
- invoice_id string? - The ID of the invoice.
- debit_memo_id string? - The ID of the debit memo.
- payment_method_id string? - The ID of the payment method.
- currency string? - The type of the currency used.
- status string? - The status of the retry cycle.
- current_attempt_number decimal? - The number of the current retry attempt.
- next_attempt string? - The date and time of the next retry attempt, in
yyyy-mm-dd hh:mm:ssformat.
- customer_group string? - The name of the customer group.
- attempts GETCycleElementAttemptResponse[]? - An array containing information of the retry attempts that have been made. See the schema and example for details.
zuora.collection: GETAccountCycleHistoryResponse
Fields
- cycles GETAccountCycleElementResponse[]? - An array containing information of all completed retry cycles for an account. See the example for details.
zuora.collection: GETActiveAccountCycleResponse
Fields
- cycles GETAccountCycleElementResponse[]? - An array containing information of all active retry cycles for an account. See the schema and example for details.
zuora.collection: GETActiveDebitMemoCycleResponse
Fields
- cycles GETDebitMemoCycleElementResponse[]? - An array containing information of all active retry cycles for a debit memo. See the schema and example for details.
zuora.collection: GETActiveInvoiceCycleResponse
Fields
- cycles GETInvoiceCycleElementResponse[]? - An array containing information of all active retry cycles for an invoice. See the schema and example for details.
zuora.collection: GETAmountRecoveredResponse
Fields
- currency string[]? - An array containing the following information for each available currency.
If no payment of a given currency has been processed over the last 30 days, the currency will not appear in the array.
- The total amount recovered to date
- The amount recovered over the last 30 days
- success boolean? - Indicates whether the metrics are retrieved successfully.
If no data is loaded yet, a 200 response code will be returned with the success field set to
true. All expected fields will be present but the value will benull.
zuora.collection: GETBaselineMetricsResponse
Fields
- retry_success_rate decimal? - The percentage of successful payment attempts for all customer groups on this Configurable Payment Retry instance so far. Retry Success Rate = Number of successful retry payment attempts / Total number of retry payments attempted Payment attempts here are any payment attempts executed by Configurable Payment Retry, excluding the initial payment run.
- retry_success_rate_trend string? - The trend of change in Retry Success Rate over the last 30 days.
- document_success_rate decimal? - The percentage of billing documents that are successfully collected, for all customer groups on this Configurable Payment Retry instance so far. Document Success Rate = Number of billing documents collected / Total number of billing documents attempted Billing documents collected are any invoices and debit memos that were paid through the payment attempt initiated by Configurable Payment Retry.
- document_success_rate_trend string? - The trend of change in Document Success Rate over the last 30 days.
- average_days_outstanding decimal? - The average number of days invoices and debit memos are unpaid before collection, for all customer groups on this Configurable Payment Retry instance so far.
- average_days_outstanding_trend string? - The trend of change in Average Days Outstanding over the last 30 days.
- success boolean? - Indicates whether the metrics are retrieved successfully.
If no data is loaded yet, a 200 response code will be returned with the success field set to
true. All expected fields will be present but the value will benull.
zuora.collection: GETCollectionAccountsResponse
Fields
- accounts CollectionAccount[]? - The array of accounts.
- pagination ResultsPagination? - The pagination information.
zuora.collection: GETCollectionAgentsResponse
Fields
- accounts CollectionAgent? -
- pagination ResultsPagination? - The pagination information.
zuora.collection: GETCustomerGroupMetricsResponse
Fields
- customer_groups CustomerGroups[]? - An array containing the following information for each customer group.
- Customer group ID
- Customer group name
- Whether Smart Retry is enabled for this customer group
- Document Success Rate indicating the percentage of billing documents that are successfully collected
- The trend of change in Document Success Rate over the last 30 days
- Retry Success Rate indicating the percentage of the successful payment attempts
- Average Attempts indicating the average number of attempts required to recover funds
- success boolean? - Indicates whether the metrics are retrieved successfully.
If no data is loaded yet, a 200 response code will be returned with the success field set to
true. All expected fields will be present but the value will benull.
zuora.collection: GETCycleElementAttemptResponse
Fields
- attempt_number decimal? - The number of the retry attempt.
- zuora_payment_id string? - The ID of the payment in Zuora Payments.
- time_of_execution string? - The date and time when the retry attempt was made, in
yyyy-mm-dd hh:mm:ssformat.
- 'source string? - The number of the failed payment run.
- cpr_generated boolean? - Indicates whether the first retry attempt was generated by Configurable Payment Retry.
truefor the cases of the first retry attempt generated by CPR and the second or later attempt.falsefor the cases that the retry attempt was made by the payment run or an external source during retry cycles.
- success boolean? - Indicates whether the retry attempt is successful.
- amount_collected decimal? - The amount collected in this retry attempt.
- action_info GetcycleelementattemptresponseActionInfo? - Information about the action of the retry attempt.
- retry_info GetcycleelementattemptresponseRetryInfo? - Information about the next retry attempt.
- mapping_info GetcycleelementattemptresponseMappingInfo? - Information about the response code mapping for the retry attempt.
- gateway_info GetcycleelementattemptresponseGatewayInfo? - Information about the payment gateway.
zuora.collection: GetcycleelementattemptresponseActionInfo
Information about the action of the retry attempt.
Fields
- action string? - The action taken in the retry attempt.
zuora.collection: GetcycleelementattemptresponseGatewayInfo
Information about the payment gateway.
Fields
- id string? - The ID of the payment gateway.
- code string? - The response code from the gateway.
- response string? - The response message from the gateway.
zuora.collection: GetcycleelementattemptresponseMappingInfo
Information about the response code mapping for the retry attempt.
Fields
- label string? - The response code label, can be
Hard Decline,Soft Decline,System Error, or custom labels.
- level string? - The response code level for the payment gateway, can be
CodeorDescription.
- customer_group_id decimal? - The ID of the customer group.
zuora.collection: GetcycleelementattemptresponseRetryInfo
Information about the next retry attempt.
Fields
- next string? - The date and time of the next retry attempt as determined by
criteria, inyyyy-mm-dd hh:mm:ssformat.
- criteria string? - The criteria defined in the retry configuration in the CPR UI, to specify whether the next retry will occur in an incremental time or at a specific time or day.
zuora.collection: GETDebitMemoCycleElementResponse
Fields
- account_id string? - The ID of the customer account.
- debit_memo_id string? - The ID of the debit memo.
- payment_method_id string? - The ID of the payment method.
- currency string? - The type of the currency used.
- status string? - The status of the retry cycle.
- current_attempt_number decimal? - The number of the current retry attempt.
- next_attempt string? - The date and time of the next retry attempt, in
yyyy-mm-dd hh:mm:ssformat.
- customer_group string? - The name of the customer group.
- attempts GETCycleElementAttemptResponse[]? - An array containing information of the retry attempts that have been made. See the schema and example for details.
zuora.collection: GETDebitMemoCycleHistoryResponse
Fields
- cycles GETDebitMemoCycleElementResponse[]? - An array containing information of all completed retry cycles for a debit memo. See the example for details.
zuora.collection: GETDocumentSuccessRateByCustomerGroupResponse
Fields
- customer_groups CustomerGroupsDetail[]? - An array containing the Document Success Rate timeseries for each customer group represented by the customer group ID.
A timeseries over the past 6 months is present in the format of
<month_year>: <document_success_rate>. The data of the current month is not included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown.
- success boolean? - Indicates whether the metrics are retrieved successfully.
If no data is loaded yet, a 200 response code will be returned with the success field set to
true. All expected fields will be present but the value will benull.
zuora.collection: GETInvoiceCycleElementResponse
Fields
- account_id string? - The ID of the customer account.
- invoice_id string? - The ID of the invoice.
- payment_method_id string? - The ID of the payment method.
- currency string? - The type of the currency used.
- status string? - The status of the retry cycle.
- current_attempt_number decimal? - The number of the current retry attempt.
- next_attempt string? - The date and time of the next retry attempt, in
yyyy-mm-dd hh:mm:ssformat.
- customer_group string? - The name of the customer group.
- attempts GETCycleElementAttemptResponse[]? - An array containing information of the retry attempts that have been made. See the schema and example for details.
zuora.collection: GETInvoiceCycleHistoryResponse
Fields
- cycles GETInvoiceCycleElementResponse[]? - An array containing information of all completed retry cycles for an invoice. See the example for details.
zuora.collection: GETPaymentRunResponse
Fields
- success boolean? - Whether the operation is successful.
- id int? - The ID of the payment run in Advanced Payment Manager.
- status string? - The status of the payment run.
- target_date string? - The target date of the payment run, in the format of YYYY-MM-DD.
- filter string? - The filter that is used for the payment run.
- payment_run_schedule_id string? - The ID of the payment run schedule. If this is not a scheduled payment run, the value is Adhoc.
- invoices_held record {}? - Invoices that are held by the payment run for manual processing.
- metrics record {}? - Metrics of the payment runs after completion.
- errors anydata[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: GETPaymentRunScheduleResponse
Fields
- success boolean? - Whether the operation is successful.
- id int? - The ID of the payment run schedule in Advanced Payment Manager.
- status string? - The status of the payment run schedule.
- filter string? - The filter that is defined in the payment run schedule.
- schedule string? - The schedule that is defined for this payment run schedule.
- errors anydata[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: GETPaymentRunSchedulesResponse
Fields
- schedules record {}[]? - An array containing all available schedules.
- size int? - The number of schedules retrieved.
- success boolean? - Whether the operation is successful.
- errors anydata[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: GETStatementSettingsResponse
Fields
- success boolean? - Whether the operation is successful.
- templates GetstatementsettingsresponseTemplates[]? - An array containing all available templates.
- advanced_ar boolean? - Whether Invoice Settlement is enabled on the tenant.
- default_template string? - The name of the default template.
- default_cycle string? - The statement cycle being used.
zuora.collection: GetstatementsettingsresponseTemplates
Fields
- name string? - The name of the template.
zuora.collection: GETStatementsResponse
Fields
- statements record {}[]? - An array containing the requested number of statements of the specified account. Every object contains an Amazon S3 link. You can click the links to view and download the statements. The links will expire in 10 minutes.
- success boolean? - Whether the operation is successful.
- count int? - The number of statements retrieved.
zuora.collection: InlineResponse200
Fields
- success boolean? - Whether the operation is successful.
zuora.collection: InlineResponse2001
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2002
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2003
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2004
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2005
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2006
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2007
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: InlineResponse2008
Fields
- success boolean? - Indicates whether the operation is successful.
- message string? - The response message.
zuora.collection: NotesComment
Fields
- id int? - The ID of the comment.
- body string? - The body of the comment.
- image string? - The link to the image file. The value is null if no image files are available.
- attachment string? - The link to the attachment. The value is null if no attachments are available.
- createdAt string? - The time and date when this comment is created.
- updatedAt string? - The last time and date when the comment is updated.
- user NotesUser? -
- replies NotesReply[]? - An array of replies.
zuora.collection: NotesCreateGroupBody
Fields
- name string? - The name of the group that you want to create.
- description string? - Additional information about the group.
zuora.collection: NotesCreateGroupResponse
Fields
- success boolean? - Whether the operation is successful.
- id int? - The ID of the Notes group.
- name string? - The name of the group.
- description string? - Additional information about the group.
- created_at string? - The date and time when the group was created.
- updated_at string? - The last date and time when the group was updated.
- users NotesUser[]? - An array of users in the group.
zuora.collection: NotesDeleteGroupBody
Fields
- name string? - The name of the group that has been deleted.
- description string? - The description of the group.
zuora.collection: NotesGroup
Fields
- id int? - The ID of the Notes group.
- name string? - The name of the group.
- description string? - Additional information about the group.
- created_at string? - The date and time when the group was created.
- updated_at string? - The last date and time when the group was updated.
- users NotesUser[]? - A list of all users in the group.
zuora.collection: NotesGroupsResponse
Fields
- success boolean? - Whether this operation is successful.
- groups NotesGroup[]? -
zuora.collection: NotesObject
Fields
- success boolean? - Whether this operation is successful or not.
- data NotesobjectData? -
zuora.collection: NotesobjectData
Fields
- id int? - The ID of the Notes object.
- 'object string? - The type of the object. It can be "Accounts" or "Invoices" for Collections Window.
- notesId string? - The ID of the Notes object. It is an account number (32-digit hex) for Accounts object type, and an invoice number for Invoices object type.
- notesParentId string? - The ID of the parent object. For "Accounts" object, this parameter is the account name that the Notes object is created for.
- createdAt string? - The time and date when this Notes object is created.
- updatedAt string? - The last time and date when the Notes object is updated.
zuora.collection: NotesObjectWithComment
Fields
- success boolean? - Whether this operation is successful or not.
- data NotesobjectwithcommentData? -
zuora.collection: NotesobjectwithcommentData
Fields
- id int? - The ID of the Notes object.
- 'object string? - The type of the object. It can be "Accounts" or "Invoices" for Collections Window.
- notesId string? - The ID of the notes object. It is an account number (32-digit hex) for Accounts object type, and an invoice number for Invoices object type.
- notesParentId string? - The ID of the parent object. For "Accounts" object, this parameter is the account name that the Notes object is created for.
- createdAt string? - The time and date when this Notes object is created.
- updatedAt string? - The last time and date when the Notes object is updated.
- comments NotesComment[]? - The array of comments for this Notes object.
zuora.collection: NotesReply
Fields
- id int? - The ID of the reply.
- body string? - The body of the reply.
- image string? - The link to the image file. The value is null if no image files are available.
- attachment string? - The link to the attachment. The value is null if no attachments are available.
- createdAt string? - The time and date when the reply is created.
- updatedAt string? - The last time and date when the reply is updated.
- user NotesUser? -
zuora.collection: NotesTasks
Fields
- id int? - The ID of the task.
- task string? - The title of the task.
- description string? - Additional details about the task.
- dueDate string? - The due date and time of the task.
- createdAt string? - The date and time when this task is created.
- updatedAt string? - The last date and time when the task is updated.
- reminderDate string? - The data and time when a reminder about this task needs to be sent.
- notifications string? - The message to be sent as notifications. It can be null if no message is defined.
- status string? - The status of the task.
- comment string? - The comment about the task.
- autoEscalation string? - The automatic escalation setting for the task.
- createdBy NotesUser? -
- assignTo NotesUser? -
zuora.collection: NotesTasksResponse
Fields
- success boolean? - Whether this operation is successful.
- data NotestasksresponseData? - The actual tasks data.
- pagination NotestasksresponsePagination? -
zuora.collection: NotestasksresponseData
The actual tasks data.
Fields
- tasks NotestasksresponseDataTasks[]? -
zuora.collection: NotestasksresponseDataTasks
Fields
- id int? - The ID of the task.
- task string? - The title of the task.
- description string? - Additional details about the task.
- dueDate string? - The due date and time of the task.
- createdAt string? - The date and time when this task is created.
- updatedAt string? - The last date and time when the task is updated.
- reminderDate string? - The data and time when a reminder about this task needs to be sent.
- notifications string? - The message to be sent as notifications. It can be null if no message is defined.
- status string? - The status of the task.
- comment string? - The comment about the task.
- autoEscalation string? - The automatic escalation setting for the task.
- createdBy NotesUser? -
- assignTo NotesUser? -
zuora.collection: NotestasksresponsePagination
Fields
- page int? - The number of the current page.
- per_page int? - The number of results on each page.
- total_filtered_records int? - The total number of filtered records.
- total_records int? - The total number of records.
zuora.collection: NotesUpdateGroupBody
Fields
- name string? - The new name of the group.
- description string? - The new description about the group.
zuora.collection: NotesUser
Fields
- id int? - The ID of the Notes user.
- username string? - The user name.
- connectIdentity string? - The connect ID of the user. It must be a 32-digit hex number.
- email string? - The email address of the user.
- firstName string? - The first name.
- lastName string? - The last name.
- fullName string? - The full name of the user.
- platformRole string? - The Platform role of the user.
- timeZone string? - The time zone setting for the user.
- createdAt string? - The time and date when this user record is created.
- updatedAt string? - The last time and date when the user record is updated.
- escalationUser string? - The full name of the user that is configured to handle escalations for the current user.
- escalationUserId string? - The ID of the escalation user. It must be a 32-digit hex number.
- approvalAmount decimal? - The amount of money that this user is allowed to approve.
- avatar string? - The link to the avatar image file for the user.
zuora.collection: PaymentsExecutePaymentsBody
Fields
- account_ids string[]? - IDs of accounts.
- debit_memo_ids string[]? - IDs of debit memos.
- invoice_ids string[]? - IDs of invoices.
zuora.collection: PaymentsSubmitFailedPaymentBody
Fields
- payment_id string? - ID of a failed payment.
zuora.collection: POSTAdhocStatementRun
Fields
- starting_date string - The starting date of the time period for which the statement is generated, in the format of MM-DD-YYYY.
- ending_date string - The ending date of the time period for which the statement is generated, in the format of MM-DD-YYYY.
- template_name string - The name of the template to be used in the statement run.
- advanced_ar boolean - Specifies whether Invoice Settlement is enabled on the tenant.
- account_id string - The ID of the account for which the statement run is created.
- attach_to_account boolean? - Indicates whether the generated statement is attached to the account.
zuora.collection: POSTAdhocStatementRunResponse
Fields
- success boolean? - Whether the operation is successful.
- code int? - The response code.
- message string? - The response message.
- statement_number string? - The number of the statement.
zuora.collection: POSTCustomStatementRun
Fields
- starting_date string - The starting date of the time period for which the statement is generated, in the format of MM-DD-YYYY.
- ending_date string - The ending date of the time period for which the statement is generated, in the format of MM-DD-YYYY.
- batch string - The billing batch of accounts the statements need to be generated for.
- mode string - The mode in which the run has to be executed.
zuora.collection: POSTCustomStatementRunResponse
Fields
- success boolean? - Whether the operation is successful.
- code int? - The response code.
- message string? - The response message.
- execution_number string? - The serial number of the execution.
- report_file string? - The URL pointing to the report of the run.
zuora.collection: POSTPaymentRun
Fields
- target_date string? - The target date of the payment run to be created, in the format of YYYY-MM-DD.
- billrun string? - A bill run name that is used to determine what receivables should be included in the payment run. Valid only if the custom filter is not used.
- batch string? - A batch name that is used to determine what receivables should be included in the payment run. Valid only if the custom filter is not used.
- currency string? - A three-character currency code that is used to determine what receivables should be included in the payment run. Valid only if the custom filter is not used.
- payment_gateway string? - A payment gateway name that is used to determine what receivables should be included in the payment run. Valid only if the custom filter is not used.
- bill_cycle_day string? - A bill cycle day value that is used to determine what receivables should be included in the payment run. Valid only if the custom filter is not used.
- custom string? - A custom ZOQL query that is used to determine what receivables should be included in the payment run. It cannot be used with other filters.
zuora.collection: POSTPaymentRunResponse
Fields
- id int? - The ID of the payment run in Advanced Payment Manager.
- success boolean? - Whether the operation is successful.
- errors string[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: POSTPaymentRunSchedule
Fields
- frequency string? - The frequency of payment runs in the schedule.
- day string? - The day of a month when payment runs need to be performed. Required only if frequency is Monthly. Allowed values are 1-31 or L (the last day of a month).
- day_of_week int[]? - An array of days in a week when payment runs need to be performed. Required only if frequency is Weekly. Allowed integers are 1-7. 1 stands for Monday. 2 stands for Tuesday, etc.
- hour int? - The hour of a day when payment runs need to be performed. Allowed values are 1-23.
- billrun string? - A bill run name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- batch string? - A batch name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- currency string? - A three-character currency code that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- payment_gateway string? - A payment gateway name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- bill_cycle_day string? - A bill cycle day value that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- custom string? - A custom ZOQL query that is used to determine what receivables should be included in payment runs in this schedule. It cannot be used with other filters.
zuora.collection: POSTPaymentRunScheduleResponse
Fields
- id int? - The ID of the payment run schedule in Advanced Payment Manager.
- success boolean? - Whether the operation is successful.
- errors string[]? - Errors that occur in the operation. Available only when success is false.
zuora.collection: ProxyConfig
Closed record
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.collection: PUTPaymentRunSchedule
Fields
- frequency string? - The frequency of payment runs in the schedule.
- day string? - The day of a month when payment runs need to be performed. Required only if frequency is Monthly. Allowed values are 1-31 or L (the last day of a month).
- day_of_week int[]? - An array of days in a week when payment runs need to be performed. Required only if frequency is Weekly. Allowed integers are 1-7. 1 stands for Monday. 2 stands for Tuesday, etc.
- hour int? - The hour of a day when payment runs need to be performed. Allowed values are 1-23.
- billrun string? - A bill run name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- batch string? - A batch name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- currency string? - A three-character currency code that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- payment_gateway string? - A payment gateway name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- bill_cycle_day string? - A bill cycle day value that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
- custom string? - A custom ZOQL query that is used to determine what receivables should be included in payment runs in this schedule. It cannot be used with other filters.
zuora.collection: ResultsPagination
The pagination information.
Fields
- page int? - The current page.
- page_length int? - The number of result on each page.
- next_page string? - The link to the next page of results.