Sign in
Invoice Schedules

Execute an invoice schedule

Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously.

When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID.

  • If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed.
  • If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed.

A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by this "Execute an invoice schedule" API operation. In this case, you can do one of the following:

  • Use the <a href="https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/" target="_blank">Generate billing documents by account ID</a> API operation
  • Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API

For more samples, see Execute invoice schedules.

Note: This operation is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-billing-schedule-overview" target="_blank">Billing Schedule</a> feature enabled.

post/v1/invoice-schedules/{scheduleKey}/execute

Path parameters

scheduleKeystring required

The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

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-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

scheduleItemIdstring

The ID of the invoice schedule item to be executed.

The item must be the earliest pending schedule item. If all the invoice schedule items have been processed and credit is needed to be generated, do not specify this field in the request.

Example request

{
  "scheduleItemId": "8ad09b7d82b5c62f0182c5cd16944f73"
}

Response

OK

autoEmailboolean

Whether to automatically send an email after Auto-Post is complete.

autoPostboolean

Whether to automatically post the bill run after the bill run is created.

autoRenewalboolean

Whether to automatically renew auto-renew subscriptions that are up for renewal.

batchesstring[]

A list of the batches of accounts for this bill run.

This field cannot exist with the billRunFilters field.

Values: AllBatches or Batchn where n is a number between 1 and 50, for example, Batch7.

billCycleDaystring

The day of the bill cycle, this field is only valid when batches is specified.

Values:

  • AllBillCycleDays or 1 - 31 for an ad-hoc bill run
  • AllBillCycleDays or 1 - 31 or AsRunDay for a scheduled bill run
billRunNumberstring

The number of bill run.

chargeTypeToExcludestring[]

The types of the charges to be excluded from the generation of billing documents.

createdByIdstring

The ID of the user who created the bill run.

createdDatestring

The date and time when the bill run was created.

idstring

The unique ID of the bill run.

invoiceDatestring date

The invoice date for this bill run, only valid for ad-hoc bill runs.

invoiceDateOffsetinteger

The offset compared to bill run execution date, only valid for scheduled bill runs.

noEmailForZeroAmountInvoiceboolean

Whether to suppress emails for invoices with the total amount of zero or not for this bill run after the bill run is complete.

Note: Do not email invoices with the total amount of zero.

scheduledExecutionTimestring

The scheduled execution time for a bill run.

status'Pending' | 'Processing' | 'Completed' | 'Error' | 'Canceled' | 'Posted' | 'PostInProgress' | 'CancelInProgress' | 'RemoveInProgress' | 'Paused'

The status of the bill run.

targetDatestring date

The target date for this bill run, only valid for ad-hoc bill run.

targetDateOffsetinteger

The offset compared to bill run execution date, only valid for scheduled bill run.

updatedByIdstring

The ID of the user who updated the bill run.

updatedDatestring

The date and time when the bill run was updated.

Example response

{
  "autoEmail": false,
  "autoPost": false,
  "autoRenewal": false,
  "billRunFilters": [
    {
      "accountId": "2c9081a03c63c94c013c66688a2c00bf",
      "filterType": "Subscription",
      "subscriptionId": "402882297e387c51017e38a245c313db"
    }
  ],
  "billRunNumber": "BR-00000016",
  "chargeTypeToExclude": [
    "OneTime",
    "Usage"
  ],
  "createdById": "ff808081298c6e5401298c7274a40005",
  "createdDate": "2022-01-24 19:58:27",
  "id": "2c9890077e8a8490017e8bf3a5171a43",
  "invoiceDate": "2020-02-01",
  "noEmailForZeroAmountInvoice": false,
  "status": "Pending",
  "success": true,
  "targetDate": "2020-02-01",
  "updatedById": "ff808081298c6e5401298c7274a40005",
  "updatedDate": "2022-01-24 19:58:27"
}

Changes