> 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.

# Payment schedule import fields

> Use this reference to view all the fields associated with the payment schedule data dictionary.

Use this reference to view all the fields associated with the payment schedule data dictionary.

> **Note**
>
> Fields with an asterisk mark indicate mandatory fields.

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

    <th>
      Description
    </th>

    <th>
      Value
    </th>
  </tr>

  <tr>
    <td>
      Items PaymentOption Detail SecCode
    </td>

    <td>
      SEC (Standard Entry Class) code information
    </td>

    <td>
      3 letter code
    </td>
  </tr>

  <tr>
    <td>
      PaymentOption Detail SecCode
    </td>

    <td>
      SEC (Standard Entry Class) code information
    </td>

    <td>
      3 letter code
    </td>
  </tr>

  <tr>
    <td>
      Currency
    </td>

    <td>
      Currency of the payment schedule.
    </td>

    <td>
      3 letter currency code
    </td>
  </tr>

  <tr>
    <td>
      Items Currency
    </td>

    <td>
      The currency of the payment.
    </td>

    <td>
      3 letter currency code
    </td>
  </tr>

  <tr>
    <td>
      Account Number\*
    </td>

    <td>
      Account number of the customer account the payment schedule belongs to.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Billing Document Number
    </td>

    <td>
      ID of the billing document. NOTE: If a billing document is specified, either `id` or `number` of the billing document must be specified.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Description
    </td>

    <td>
      Description of the payment schedule.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Items Billing Document Number
    </td>

    <td>
      ID of the billing document. NOTE: If a billing document is specified, either `id` or `number` of the billing document must be specified.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Items Description
    </td>

    <td>
      Description of the payment schedule item.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Items PaymentOption Type
    </td>

    <td>
      The type of the payment option.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Payment Schedule Number
    </td>

    <td>
      You can use this field to specify a unique number of the payment schedule.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      PaymentOption Type
    </td>

    <td>
      The type of the payment option.
    </td>

    <td>
      Alphanumeric
    </td>
  </tr>

  <tr>
    <td>
      Account Id\*
    </td>

    <td>
      ID of the customer account the payment schedule belongs to.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Billing Document Id
    </td>

    <td>
      ID of the billing document.

      > **Note**
      >
      > If a billing document is specified, either `id` or `number` of the billing document must be specified.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Items Billing Document Id
    </td>

    <td>
      ID of the billing document.

      > **Note**
      >
      > If a billing document is specified, either `id` or `number` of the billing document must be specified.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Items Payment Gateway Id
    </td>

    <td>
      The ID of the payment gateway.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Items Payment Method Id
    </td>

    <td>
      The ID of the payment method.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Payment Gateway Id
    </td>

    <td>
      ID of the payment gateway.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Payment Method Id
    </td>

    <td>
      ID of the payment method.
    </td>

    <td>
      Alphanumeric Id
    </td>
  </tr>

  <tr>
    <td>
      Pre-Payment
    </td>

    <td>
      Indicates whether the payments created by the payment schedule will be used as reserved payments.
    </td>

    <td>
      Boolean(TRUE|FALSE)
    </td>
  </tr>

  <tr>
    <td>
      Standalone
    </td>

    <td>
      Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to `null`, standalone payment will be created.
    </td>

    <td>
      Boolean(TRUE|FALSE)
    </td>
  </tr>

  <tr>
    <td>
      Items Scheduled Date
    </td>

    <td>
      The date to collect the payment.
    </td>

    <td>
      Date(YYYY-MM-dd)
    </td>
  </tr>

  <tr>
    <td>
      Start Date
    </td>

    <td>
      The date for the first payment collection.
    </td>

    <td>
      Date(YYYY-MM-dd)
    </td>
  </tr>

  <tr>
    <td>
      Amount
    </td>

    <td>
      The amount of each payment schedule item in the payment
    </td>

    <td>
      Decimal
    </td>
  </tr>

  <tr>
    <td>
      Items Amount
    </td>

    <td>
      The amount that needs to be collected by this payment schedule item.
    </td>

    <td>
      Decimal
    </td>
  </tr>

  <tr>
    <td>
      Total Amount
    </td>

    <td>
      The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules.
    </td>

    <td>
      Decimal
    </td>
  </tr>

  <tr>
    <td>
      Billing Document Type\*
    </td>

    <td>
      The type of the billing document.
    </td>

    <td>
      Invoice,DebitMemo
    </td>
  </tr>

  <tr>
    <td>
      Items Billing Document Type\*
    </td>

    <td>
      The type of the billing document.
    </td>

    <td>
      Invoice,DebitMemo
    </td>
  </tr>

  <tr>
    <td>
      Period
    </td>

    <td>
      The frequency for the payment collection since the `startDate`.
    </td>

    <td>
      Monthly,Weekly,BiWeekly
    </td>
  </tr>

  <tr>
    <td>
      Occurrences
    </td>

    <td>
      The number of payment schedule item to be created.
    </td>

    <td>
      Number(0-1000)
    </td>
  </tr>

  <tr>
    <td>
      Items Run Hour
    </td>

    <td>
      At which hour in the day in the tenant’s timezone this payment will be collected.
    </td>

    <td>
      Number(0-23)
    </td>
  </tr>

  <tr>
    <td>
      Run Hour
    </td>

    <td>
      Specifies at which hour in the day in the tenant’s time zone when this payment will be collected.
    </td>

    <td>
      Number(0-23)
    </td>
  </tr>

  <tr>
    <td>
      IsNewItems
    </td>

    <td>
      Marker Column
    </td>

    <td>
      TRUE,FALSE
    </td>
  </tr>

  <tr>
    <td>
      IsNewItemsPaymentOption
    </td>

    <td>
      Marker Column
    </td>

    <td>
      TRUE,FALSE
    </td>
  </tr>

  <tr>
    <td>
      IsNewPaymentOption
    </td>

    <td>
      Marker Column
    </td>

    <td>
      TRUE,FALSE
    </td>
  </tr>

  <tr>
    <td>
      IsNewPaymentSchedule
    </td>

    <td>
      Marker Column
    </td>

    <td>
      TRUE,FALSE
    </td>
  </tr>
</table>