Update a payment run

PUT

/v1/payment-runs/:paymentRunKey

PUT

/v1/payment-runs/:paymentRunKey

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.payment_runs.put_payment_run(
    payment_run_key="paymentRunKey",
    auto_apply_unapplied_payment=True,
)

200response

{
  "accountId": "402890245f097f39015f0e9fcdd60558",
  "autoApplyCreditMemo": true,
  "autoApplyUnappliedPayment": true,
  "collectPayment": true,
  "completedOn": null,
  "consolidatedPayment": true,
  "createdById": "402881e522cf4f9b0122cf5d82860002",
  "createdDate": "2017-09-22 12:37:22",
  "executedOn": null,
  "id": "402890245f097f39015f0f074a2e0566",
  "number": "PR-00000391",
  "processPaymentWithClosedPM": true,
  "status": "Pending",
  "success": true,
  "targetDate": "2017-10-12",
  "updatedById": "402881e522cf4f9b0122cf5d82860002",
  "updatedDate": "2017-09-22 12:37:22",
  "rundate": null
}

Updates the information about an unexecuted payment run. Only pending payment runs can be updated.

If none of the accountId, batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields is specified in the request body, the corresponding payment run collects payments for all accounts.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

paymentRunKeystringRequired

The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.

Headers

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Request

This endpoint expects an object.

accountIdstringOptionalformat: "uuid"

The ID of the customer account associated with the payment run.

This field conflicts with each of the batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields. If there are such conflicts, an error occurs and an error message is returned.

applyCreditBalancebooleanOptional

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.

autoApplyCreditMemobooleanOptional

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Whether to automatically apply a posted credit memo to one or more receivables in the payment run.

autoApplyUnappliedPaymentbooleanOptional

Whether to automatically apply unapplied payments to one or more receivables in the payment run.

batchstringOptional

The alias name given to a batch. The batch name is a string of 50 characters or less.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.

billCycleDaystringOptional

The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

billingRunIdstringOptionalformat: "uuid"

The ID of a bill run.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

collectPaymentbooleanOptional

Whether to process electronic payments during the execution of payment runs. If the Payment user permission "Process Electronic Payment" is disabled, this field will be ignored.

consolidatedPaymentbooleanOptional

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.

currencystringOptional

A currency defined in the web-based UI administrative settings.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

organizationLabelslist of objectsOptional

The organizations that the run is created for.

For each item in the array, either the organizationId or the organizationName field is required.

This field is only required when you have already turned on Multi-Org feature.

paymentGatewayIdstring or nullOptionalformat: "uuid"

The ID of the gateway instance that processes the payment.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

processPaymentWithClosedPMbooleanOptional

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.

runDatestringOptional

The date and time when the scheduled payment run is to be executed, in yyyy-mm-dd hh:mm:ss format. The backend will ignore mintues and seconds in the field value. For example, if you specify 2017-03-01 11:30:37 for this value, this payment run will be run at 2017-03-01 11:00:00.

targetDatedateOptional

The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

accountIdstringOptional

The ID of the customer account associated with the payment run.

applyCreditBalancebooleanOptional

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.

autoApplyCreditMemobooleanOptional

Whether to automatically apply a posted credit memo to one or more receivables in the payment run.

autoApplyUnappliedPaymentbooleanOptional

Whether to automatically apply unapplied payments to one or more receivables in the payment run.

batchstringOptional

The alias name given to a batch.

billCycleDaystringOptional

The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.

billingRunIdstringOptionalformat: "uuid"

The ID of the bill run.

collectPaymentbooleanOptional

Whether to process electronic payments during the execution of payment runs.

completedOnstring or nullOptional

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.

consolidatedPaymentbooleanOptional

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.

createdByIdstringOptional

The ID of the Zuora user who created the payment run.

createdDatestringOptional

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.

currencystringOptional

A currency defined in the web-based UI administrative settings.

executedOnstring or nullOptional

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.

idstringOptional

The ID of the payment run.

numberstringOptional

The identification number of the payment run.

organizationLabelslist of objectsOptional

The organization(s) that the object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

paymentGatewayIdstring or nullOptionalformat: "uuid"

The ID of the gateway instance that processes the payment.

processPaymentWithClosedPMbooleanOptional

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.

runDatestringOptional

The date and time when the scheduled payment run is to be executed for collecting payments.

statusenumOptional

The status of the created payment run.

Allowed values:

successbooleanOptional

Returns true if the request was processed successfully.

targetDatedateOptional

The target date used to determine which receivables to be collected in the payment run.

updatedByIdstringOptional

The ID of the Zuora user who last updated the payment run.

updatedDatestringOptional

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.

useCustomPaymentMethodsbooleanOptional

Whether to enable payment profiles for a payment run.