A billing template describes a reusable billing run, including the jobs it runs and the date ranges those jobs use. Jobs can send notices or move schools between phases. Because the date ranges are relative to when you use the template, the same template can create a correctly dated run each time. This article explains how to define, retire, and delete billing templates.
Prerequisites
You need access to Accreditation Setup and Billing to manage billing templates.
What This Controls
- Which jobs a billing run created from this template will run, including each job’s filters and options.
- Date ranges that are relative to when you use the template, so the same template works for any period.
- Whether the template appears in Console pickers when you create a new run.
Where to Find It
Go to Setup › Billing › Templates to see every billing template in your account. Create a new template, or open an existing template to edit it.
Create or Edit a Billing Template
- Go to Setup › Billing › Templates.
- Create a new template, or open an existing one to edit it.
- Switch on each job you want the template to run, then complete that job’s filters and options with relative date ranges.
- Save the template.
You must complete the filters and options for every job you switch on. If anything is missing, Rhythm refuses the save and shows a validation error.
Switching a Job Off Clears Its Options
Warning
When you save a template from the Console with a job switched off, Rhythm drops that job’s saved options instead of hiding them. If you switch the job back on later, you must enter its filters and options again. When you save through the API, Rhythm keeps the job options that were sent, whether the job is switched on or off.
Retire a Template
Deactivate a template, or the notice it uses, to remove it from Console picker lists for new runs without deleting it. Retirement only changes whether the item appears in pickers. Anything that already names the template or notice keeps using it exactly as before.
When you edit a template, Accreditation shows how many recurring schedules currently use it, so you can understand the scope before you make a change. This count includes only recurring schedules, not runs already generated from the template.
Delete a Template
You can delete a billing template only when no billing run or recurring schedule names it. This protection does not expire when a run finishes, so a template used by even one past run can never be deleted. If Rhythm refuses the delete, review your billing runs and recurring schedules for ones that still use the template.
Rhythm also refuses to delete a notice or team notice when any billing record still names it, whether that record is an active run, a completed run, or a recurring schedule. See Accreditation Notices for retiring or deleting a notice on its own.
Permissions
You need access to Accreditation Setup and Billing to create, edit, retire, or delete billing templates.
Validation and Errors
| Situation | What happens |
|---|---|
| A switched-on job’s filters or options are incomplete | Rhythm refuses the save and shows a validation error |
| A billing run or recurring schedule still names the template | Rhythm refuses the delete |
| A billing record still names a notice or team notice you’re trying to delete | Rhythm refuses the delete |