> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Field descriptions of BillRun

> This reference provides the description of the fields of the BillRun object.

This reference provides the description of the fields of the BillRun object.

<table>
  <tr>
    <th>
      **Name**
    </th>

    <th>
      **Required for update?**
    </th>

    <th>
      **Allowed operations**
    </th>

    <th>
      **Description**
    </th>
  </tr>

  <tr>
    <td>
      AccountId
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      Account ID for a single account bill run.

      **Type**: string

      **Character limit**: 32
    </td>
  </tr>

  <tr>
    <td>
      AutoEmail
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      `True` allows auto-send email invoices once the bill run completes.

      **Type**: boolean

      **Default**: `False`

      > **Note**
      >
      > You must enable the Support Bill Run Auto-Post Zuora Billing rule to pass this field.
    </td>
  </tr>

  <tr>
    <td>
      AutoPost
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      `True` allows auto-post bill run once the bill run completes.

      **Type**: boolean

      **Default**: `False`

      > **Note**
      >
      > You must enable the Support Bill Run Auto-Post Zuora Billing rule to pass this field.
    </td>
  </tr>

  <tr>
    <td>
      AutoRenewal
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      Flag to determine whether subscriptions are automatically renewed by this bill run.

      **Type**: boolean

      **Default**: `False`
    </td>
  </tr>

  <tr>
    <td>
      Batches
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      The specific batches of customer accounts to be included in the bill run.

      You cannot set the `Batches` field to a value consisting of both `AllBatches` and `Batchn` . Otherwise, the `INVALID_VALUE` error occurs. For example, `AllBatches,Batch3` is an invalid value for this field.

      **Type**: string

      **Character limit**: 20

      **Values**: `AllBatches` , `Batchn` or an array of `Batchn` where `n` is a number between 1 and 50
    </td>
  </tr>

  <tr>
    <td>
      BillCycleDay
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      The day of the bill cycle.

      **Type**: string

      **Character limit**: 32

      **Values**: AllBillCycleDays or 01 - 31
    </td>
  </tr>

  <tr>
    <td>
      BillRunNumber
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The number of this bill run.

      **Type**: string

      **Character limit**: 50

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ChargeTypeToExclude
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Create
    </td>

    <td>
      Charge type or types to be excluded, separated with commas.

      **Type**: string

      **Character limit**: 50

      **Values**: `OneTime` , `Recurring` , `Usage` , or a combination of two of these values
    </td>
  </tr>

  <tr>
    <td>
      CreatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The ID of the user who created the bill run.

      **Type**: string

      **Character limit**: 32

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      CreatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The date when this bill run was created.

      **Type**: dateTime

      **Character limit**: 29

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ErrorMessage
    </td>

    <td>
      optional
    </td>

    <td>
      Query
    </td>

    <td>
      Error message for this bill run.

      **Type**: string

      **Character limit**: 255

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ExecutedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      Execution date for this bill run.

      **Type**: dateTime

      **Character limit**: 29

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      Id
    </td>

    <td>
      required
    </td>

    <td>
      Query

      Filter

      Update
    </td>

    <td>
      The ID of the object.

      **Type**: string

      **Character limit**: 32

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      InvoiceDate
    </td>

    <td>
      required
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      Invoice date for this bill run.

      **Type**:

      * date: Supported as of WSDL version 69+
      * dateTime: Supported through WSDL version 68

      **Character limit**: 29
    </td>
  </tr>

  <tr>
    <td>
      InvoicesEmailed
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      Flag to indicate whether the invoice has been sent.

      **Type**: boolean

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      LastEmailSentTime
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The last time when emails were sent for this bill run.

      **Type**: dateTime

      **Character limit**: 29

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      NoEmailForZeroAmountInvoice
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      Flag to determine suppression email for invoices with zero total or not for this bill run (Do not email invoices with 0 Invoice Total)

      **Type**: boolean

      **Default**: `False`
    </td>
  </tr>

  <tr>
    <td>
      NumberOfAccounts
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The number of accounts processed by this bill run.

      **Type**: long

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      NumberOfCreditMemos
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The number of credit memos generated by this bill run.

      **Type**: long

      **Values**: automatically generated

      > **Note**
      >
      > This field is only available if you have the Invoice Settlement feature enabled.
    </td>
  </tr>

  <tr>
    <td>
      NumberOfInvoices
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The number of invoices generated by this bill run.

      **Type**: long

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      PostedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The date when the bill run was posted.

      **Type**: dateTime

      **Character limit**: 29

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      Status
    </td>

    <td>
      required
    </td>

    <td>
      Query

      Filter

      Update
    </td>

    <td>
      The status of this bill run.

      **Type**: string

      **Character limit**: 20

      **Values**: One of the following:

      * Pending
      * Processing
      * Completed
      * Error
      * Canceled
      * Posted
    </td>
  </tr>

  <tr>
    <td>
      TargetDate
    </td>

    <td>
      required
    </td>

    <td>
      Query

      Filter

      Create
    </td>

    <td>
      The target date for this bill run.

      **Type**:

      * date: Supported as of WSDL version 69+
      * dateTime: Supported through WSDL version 68

      **Character limit**: 29
    </td>
  </tr>

  <tr>
    <td>
      UpdatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The ID of the user who last updated the bill run.

      **Type**: zns:ID

      **Character limit**: 32

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      UpdatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query

      Filter
    </td>

    <td>
      The date when the bill run was last updated.

      **Type**: dateTime

      **Character limit**: 29

      **Values**: automatically generated
    </td>
  </tr>
</table>