RetrieveMonthNamesForTaxPeriods

Retrieve Month Names For Tax Periods

Minor Business Rule

Object Name: N0700111

Parent DLL: CPAY

Location: Client/Server

Language: NER

Functional Description

Purpose

The Payroll History Enquiry screens display the 12 period buckets. The beginning month for the tax
fiscal year is determined by the Country. This Business Function receives the Country as input and
returns the 12 period descriptions.
E.g.:

• USA has a tax fiscal year 01 January - 31 December. The beginning month will be 01.
• New Zealand has a tax fiscal year of 01 April - 31 March. The beginning month will be 04.

Setup Notes and Prerequisites

Special Logic

If no Country is input, then the User profile country is defaulted.

Result Indicator values:
0 Unsuccesful
1 Successful

Technical Specification

• Set Result Indicator to successful (value = 1)
• If input country blank then get value from User profile country
• Get first record from Payroll Constants table (F069096) that matches the country.
• The beginning month = Fiscal Period - Beginning Month (F069096)
• If no record found then default the beginning month to 01 (January).
• Do the following logic 12 times

• Month is numeric so must be converted to a string. The conversion strips leading zeros. This must
be replaced via text manipulation.
• Get UDC (X0005)

• 'PBFP' -> Data Dictionary Item
• Month -> User Defined Code
• Language preference -> Language Preference
• Monthxx <- Description 001
• '1' -> Suppress Error Message
• Error Code <- Error message Id

• If Error Code not null then set Result Indicator to unsuccessful (0)
• Add 1 to Month
• If Month > 12 the set Month to 01

Data Structure

D0700111 - Retrieve Month Names For Tax Periods

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szCountry	CTR	char	OPT	NONE
A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system uses the country code for data selection and address formatting.
szMonth01	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth02	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth03	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth04	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth05	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth06	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth07	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth10	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth12	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth11	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth08	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
szMonth09	AA25	char	OPT	NONE
This item is used scrub Specification Data fields that are 25 character alpha fields.
cResultIndicator	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None