Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 4.47 KB

GETPaymentRunType.md

File metadata and controls

33 lines (29 loc) · 4.47 KB

GETPaymentRunType

Properties

Name Type Description Notes
account_id str The ID of the customer account associated with the payment run. [optional]
apply_credit_balance bool Note: This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled. [optional]
auto_apply_credit_memo bool Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Whether to automatically apply a posted credit memo to one or more receivables in the payment run. [optional]
auto_apply_unapplied_payment bool Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Whether to automatically apply unapplied payments to one or more receivables in the payment run. [optional]
batch str The alias name given to a batch. [optional]
bill_cycle_day int The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. [optional]
billing_run_id str The ID of the bill run. [optional]
collect_payment bool Whether to process electronic payments during the execution of payment runs. [optional]
completed_on datetime The date and time when the payment run is completed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:39:58. [optional]
consolidated_payment bool Note: The Process Electronic Payment permission also needs to be allowed for a Manage Payment Runs role to work. See Payments Roles for more information. Whether to process a single payment for all receivables that are due on an account. [optional]
created_by_id str The ID of the Zuora user who created the payment run. [optional]
created_date datetime The date and time when the payment run was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. [optional]
currency str A currency defined in the web-based UI administrative settings. [optional]
executed_on datetime The date and time when the payment run is executed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:30:37. [optional]
id str The ID of the payment run. [optional]
number str The identification number of the payment run. [optional]
payment_gateway_id str The ID of the gateway instance that processes the payment. [optional]
process_payment_with_closed_pm bool Note: The Process Electronic Payment permission also needs to be allowed for a Manage Payment Runs role to work. See Payments Roles for more information. Whether to process payments even if the default payment method is closed. [optional]
run_date datetime The date and time when the scheduled payment run is to be executed for collecting payments. [optional]
status str The status of the created payment run. [optional]
success bool Returns `true` if the request was processed successfully. [optional]
target_date date The target date used to determine which receivables to be collected in the payment run. [optional]
updated_by_id str The ID of the Zuora user who last updated the payment run. [optional]
updated_date datetime The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. [optional]

[Back to Model list] [Back to API list] [Back to README]