Periods

Back to list of main tables

Table name is period. Periods are specific time frames which exist within schedules.

Field name	Description	mSupply Use	Reference link	Type	Indexed
ID	UUID of the period (not usually visible to the user	Not use in UI	Alpha
periodScheduleID	UUID of the periodSchedule through which period is created	Not use in UI	https://docs.msupply.org.nz/admin:schedules_periods?s[]=period#adding_schedules_and_periods	Alpha
startDate	The date on which the period begins	Periods»Start date	https://docs.msupply.org.nz/admin:schedules_periods?s[]=period#adding_schedules_and_periods	Date
endDate	The date on which the period ends	Periods»End date	https://docs.msupply.org.nz/admin:schedules_periods?s[]=period#adding_schedules_and_periods	Date
name	A user-defined name for the period	Periods»Name	https://docs.msupply.org.nz/admin:schedules_periods?s[]=period#adding_schedules_and_periods	Text
inactive	When set to true, the period is disabled and cannot be selected or used in transactions, but remains in the system for historical reference	Periods»Inactive	Boolean