About recurring template status fields

There are three Status fields on a recurring template:

• Header status: Controls the entire recurring template. Use this Status field to turn on (Active) or temporarily turn off (Inactive) a recurring transaction. This field is updated if you select a Turn on or Turn off link from the Recurring Template list.
• Line item status: Controls individual line items. Use this Status field to turn on (Active) a line item, temporarily turn off (Inactive) a line item, or to permanently stop a line item (Ended).
• Schedule status: Controls the recurring template schedule. Use this Status field to turn on the schedule (Active), temporarily turn off (Inactive) the schedule, or to permanently stop the schedule (Ended).

Precedence between status fields depends on priority: Active has the lowest priority, Inactive the middle priority, and Ended has the highest priority. The higher priority setting takes precedence. For example, if the schedule setting is Active, but the line item is Inactive, the line item takes precedence. Similarly, if the header status is Active but the schedule status is Ended, the entire recurring template is permanently stopped.

What's the difference between the header status and the schedule status?

Both the header status and the schedule status affect the entire recurring template—if one is Active and the other is Inactive, the system scheduler will ignore the recurring template. The only difference is that you can only permanently stop an in progress recurring template by setting the schedule status to Ended. There's no Ended option for the header status.

When a recurring template completes its schedule, the system automatically sets the schedule status to Ended.

What happens when a recurring template is turned off?

"Turning off" a recurring template means to set the header status or schedule status to Inactive. The system scheduler will ignore the recurring template and will not create any transactions from it. You can still edit an inactive recurring template and you can "turn on" (set the Status to Active) the recurring template if needed.

What happens when you set a recurring template or line item to Ended?

Setting the schedule status to Ended permanently stops the recurring template. No more transactions will ever be created from the recurring template. You cannot edit a recurring template after it is saved with Ended status.

Setting a line item status to Ended permanently stops the corresponding line item. It will not be included in any future transactions created from the recurring template. You can edit the recurring template and add other line items to the template if needed if the schedule status does not equal Ended.