ACI Documentation

Billing Cycles

Executive Summary

Billing Cycles is the setup screen where administrators define the billing cycles used for invoicing (for example a calendar-month cycle or a weekly cycle) and maintain the billing periods inside each cycle. Create a cycle with a frequency, then open it to generate the periods for a year, add or correct individual periods, or remove periods in bulk. Funders assigned to a cycle are listed on the cycle for reference. Whenever a period is created, a matching period is also created for every funder that uses the cycle. The cycles are maintained inside the integration only; nothing on this screen is sent to AlayaCare.

Key Features

  • Add billing cycles with a cycle code, description and frequency (Calendar Month, Weekly or Every 2 Weeks)
  • Generate a whole year of periods automatically from a first start date and starting period number
  • Add, edit and delete individual periods, or delete a range of periods for a year
  • View the funders that use the cycle, with filter and sort
  • Change a cycle's description
  • Export the list of cycles to Excel

Typical Workflow

  1. Click Add, enter the Cycle, Description and Frequency, and click Save.
  2. Click the edit icon on the cycle (or right-click and choose Edit) to open it.
  3. On the Periods tab, click Create, choose the year, the first billing period start date and the starting period number, and click Save to generate the periods for that year.
  4. Use Add, Edit or right-click Delete to adjust individual periods, or Bulk Delete to remove a range.
  5. Check the Funders tab to see which funders use the cycle.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page

Main Grid

Lists every billing cycle (14 rows per page).

ColumnDescription
CycleCycle code.
DescriptionDescription of the cycle.
FrequencyCalendar Month, Weekly or Every 2 Weeks.
Manage RecordsEdit icon that opens the cycle.

Actions

ButtonDescription
AddOpens the Billing Cycle dialog to create a cycle (also available by right-clicking the grid and choosing Add).
ExportExports the cycles to Excel with the columns Cycle, Description and Frequency. A warning "Nothing to export" is shown when there are none.
Edit (row icon, or right-click a row)Opens the cycle's details dialog.

Dialog Components

Billing Cycle (Add)

Opens from Add. Enter the Cycle code, Description and Frequency, then click Save or Cancel. A frequency is required ("Please select a valid Frequency"). The frequency cannot be changed after the cycle is created.

Billing Cycle Details

Opens from Edit. The title shows the cycle code, and the Cycle box shows the cycle and its description.

Tabs

TabPurpose
PeriodsBilling periods of the cycle, with buttons to create, add, edit and delete them.
FundersThe funders that use this cycle (read-only).
GeneralThe cycle description, with an Edit button.
Periods - Grid

Lists the periods of the cycle, newest first (12 rows per page).

ColumnDescription
YearYear of the period.
Period NumberPeriod number within the cycle.
From DateFirst day of the period.
To DateLast day of the period.
Periods - Grid Actions
ButtonDescription
AddOpens the Billing Cycle Period dialog to add one period.
EditEdits the selected row. A warning "Please select a billing cycle period" is shown if no row is selected.
CreateOpens the Create Period Details dialog to generate a year of periods.
Bulk DeleteOpens the Bulk Delete Period Details dialog.
Add, Edit, Delete, Create, Bulk Delete (right-click)The same actions from the right-click menu. Delete is available only here: it asks "Are you sure you want to delete this period?" and removes the period together with the funder periods created for it.
Funders - Grid
ColumnDescription
AC IDAlayaCare funder ID.
CodeFunder code.
NameFunder name.
DescriptionFunder description.
Invoicing ModelInvoicing model of the funder.
Funders - Grid Filters
FilterPurpose
Filter Code IncludesShows only funders whose code contains the text.
Filter Name IncludesShows only funders whose name contains the text.
Sort ByOrders the list by AC ID, Code or Name (default Code).

Click Apply to refresh the list. Use Clear to reset filters.

General tab

Shows the Description. Click Edit to open the Billing Cycle dialog, change the Description (required) and click Save.

Billing Cycle Period

Opens from Add or Edit on the Periods tab. Year and Period (1 to 12) can be entered only when adding; they are fixed when editing. Choose the From/To Date range and click Save. When adding, a warning is shown if that year and period already exist. A new period is also created for every funder that uses the cycle.

Create Period Details

Generates a year of periods in one step. The cycle and its Frequency are shown for reference.

FieldDescription
YearYear to generate. Required.
First Billing Period Start DateStart date of the first period. Required.
Starting Period NumberNumber given to the first period; later periods count up from it.

Rules by frequency:

  • Calendar Month: the start date must be the first of a month ("Starting Date has to be first of the month"). One period is created per calendar month until the year ends.
  • Weekly: each period is 7 days, starting from the start date, until the start date is no longer in the selected year.
  • Every 2 Weeks: each period is 14 days from the start date. Periods stop at the last period whose end date is still in the selected year; a period that would begin in the selected year and end in the following year is not created.

If the starting period already exists for that year the dialog warns "Starting Period already exists" and nothing is created. Any individual period number that already exists is skipped. Each period created is also created for every funder that uses the cycle.

Bulk Delete Period Details

Deletes a range of periods for one year.

FieldDescription
Delete For YearYear of the periods to delete. Required.
Starting PeriodFirst period number to delete. Required.
Ending PeriodLast period number to delete. Required.

Click Save to delete. The funder periods linked to each deleted period are deleted with it. There is no confirmation prompt.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
FundersFunders assigned to the cycle are listed on the Funders tab, and each new period is also created for those funders.