payment_frequency Struct Reference

A payment frequency code from the CDM CalculationPeriodFrequencyEnum. More...

#include <payment_frequency.hpp>

Collaboration diagram for payment_frequency:

Public Attributes
int	version = 0
	Version number for optimistic locking and change tracking.
utility::uuid::tenant_id	tenant_id = utility::uuid::tenant_id::system()
	Tenant identifier for multi-tenancy isolation.
std::string	code
	Canonical CDM code (e.g. "Annual", "Quarterly", "Daily").
std::string	name
	Human-readable name (e.g. "Quarterly").
std::string	description
	Description of the frequency.
int	display_order = 0
	Suggested display order in UI lists.
std::string	modified_by
	Username of the person who recorded this version.
std::string	change_reason_code
	Code identifying the reason for the change.
std::string	change_commentary
	Free-text commentary explaining the change.
std::string	performed_by
	Username of the account that performed this operation.
std::chrono::system_clock::time_point	recorded_at
	Timestamp when this version of the record was recorded.

Detailed Description

A payment frequency code from the CDM CalculationPeriodFrequencyEnum.

Payment frequencies define how often cash flows occur. The canonical codes follow CDM / FpML naming:

• "Once" — single payment at termination
• "Annual" — once per year
• "Semiannual" — twice per year
• "Quarterly" — four times per year
• "Bimonthly" — every two months
• "Monthly" — twelve times per year
• "Lunarmonth" — every 28 days
• "Weekly" — once per week
• "Daily" — once per business day

ORE XML allows short aliases ("A", "S", "Q", "B", "M", "L", "W", "D", "Z"). The mapper normalises all aliases to the canonical CDM code.