Accounting Module Specs

The documented modules are:

3.1 Accounting_Menu
3.1.1 Display Invoice
3.1.2 Print Invoice
3.1.3 Search Invoice
3.1.4 Paid Invoice
3.2.1 Quarterly Report
3.2.2 Date to Date Report
3.2.3 Generate Report
3.2.4 Unpaid Invoice Report

3.1 Accounting Menu

Called by:
- Main menu

Calls:
- Display Invoice
- Print Invoice
- Search Invoice
- Paid Invoice
- Quarterly Report
- Date to Date Report
- Unpaid Invoice Report
- Get Menu Item

Calling Sequence:
1. Get Menu Item
2. Any of the 8 menu options

Input:
- None

Output:
- Exit Status
  - 0 - Do not exit the program
  - 1 - Exit the program

Errors:
- None

Description:
- This modules calls Get Menu Item to wait for the user to choose a menu option. It then calls the function that the user selected. If the user choose to quit the program it return exit an exit code.

Pseusodcode:

do
  Display accounting menu
  Get the menu item from the user
  switch (menu item)
    case display_invoice
      call display_invoice()
      break
    case print_invoice
      call print_invoice()
      break
    case search_invoice
      call search_invoice()
      break
    case paid_invoice
      call paid_invoice()
      break
    case quarterly_report
      call quarterly_report()
      break
    case data_to_date_report
      call data_to_data_report()
      break
    case unpaid_invoice_report
      call unpaid_invoice_report()
      break
while (menu item != exit)
return to main menu

3.1.1 Display Invoice:
- Called by:
  - Accounting Menu
- Calls:
  1. Get Invoice Number
  2. Check Invoice Number
  3. Get Invoice
  4. Generate Invoice
  5. Display Invoice
- Calling Sequence:
  1. Get Invoice Number
  2. Check Invoice Number
  3. Get Invoice
  4. Generate Invoice
  5. Display Invoice
- Input:
  - None
- Output:
  - None
- Errors:
  - An Invalid Invoice number - Prompt the user again
  - The invoice doesn't exist.
- Description:
  - This function prompts the user for an invoice number or gets the number by prompting the user for a name and room number and then displays the invoice to the screen. The format of the invoice will be shown later.
- Pseusodcode:
```
do
  Display dialog box to get the invoice_number
  if (check_invoice(invoice_number) == valid)
    invoice = get_invoice(invoice_number)
    if (invoice == error)
      Display dialog box reporting the invalid invoise number
    Display a text box on the screen with the formated data from the invoice
  else
    Display dialog box reporting the syntax error
while (check_invoice(invoice_number) == invalid)
Return the accounting menu
        
```
3.1.2 Print Invoice
- Called by:
  - Accounting Menu
- Calls:
  - Get Invoice Number
  - Check Invoice Number
  - Get Invoice
  - Generate Invoice
  - Print Invoice
- Input:
  - None
- Output:
  - None
- Errors:
  - An Invalid Invoice number - Prompt the user again
  - The invoice doesn't exist.
- Description:
  - This function prompts the user for an invoice number and then prints a copy of the invoice on the system printer. The format of the invoice will be shown later.
- Pseusodcode:
```
do
  Display dialog box to get the invoice_number
  if (check_invoice(invoice_number) == valid)
    invoice = get_invoice(invoice_number)
    if (invoice == error)
      Display dialog box reporting the invalid invoise number
    Format the invoice and send it to the printer
  else
    Display dialog box reporting the syntax error
while (check_invoice(invoice_number) == invalid)
Return the accounting menu
        
```
3.1.3 Search for Invoice
- Called by:
  - Accounting Menu
- Calls:
  - Get Search Parameters
  - Check Search Parameters
  - Check Room Number
  - Check Employee Name
  - Check Guest Name
  - Check Date
  - Get Employee ID (Employee Name)
  - Get Guest ID (Guest Name)
  - Get Charged to (Guest ID)
  - Get Billed for (Room #)
  - Get Issued by (Employee ID)
  - Display search results
  - Display message
- Calling Sequence:
  1. Get Search Parameters
  2. Check Search Parameters
  3. Get Employee ID (If needed)
  4. Get Guest ID (If needed)
  5. Get Charged to (If needed)
  6. Get Billed for (If needed)
  7. Get Issued by (if needed)
  8. Display Seach list
  9. Display message (if needed)
- Input:
  - None
- Output:
  - None
- Errors:
  - Invalid search parameters
  - No invoice records found
- Description:
  - This function displays a search parameters window that allows the user to specify search parameters. It then checks that the given parameters are valid. With the valid parameters it finds all the invoice records that meet the given critiera. The list of invoice records is then displayed to the user.
- Pseusodcode:
```
do
  Display a text box to the user to get the search parameters
  if the search parameters are valid
    find the list of invoices billed by the employee id
    find the list of invoices billed for the guest id
    find the list of invoices for the room number
    find the list of invoices that have the date given
    cross reference the 4 invoice lists and find the invoices in common
    display the common invoice list to the user
  else
    Display a dialog to let the user know whats wrong
while search parameters are invalid
        
```

3.1.4 Paid Invoice

Called by:
- Account Menu

Calls:
- Get Invoice Number
- Check Invoice Number
- Get Invoice
- Put Invoice

Calling Sequence:
- Get Invoice Number
- Check Invoice Number
- Get Invoice
- Put Invoice

Input:
- None

Output:
- None

Errors:
- The invoice number has an invalid format
- The invoice given doesn't exist
- The invoice is already paid

Description:
- This function allows the accounting user to pay an outstanding invoice.

Pseusodcode:

do
  Display dialog box to get the invoice_number
  if (check_invoice(invoice_number) == valid)
    invoice = get_invoice(invoice_number)
    if (invoice == error)
      Display a dialog box reporting the invalid invoice number.
    else if invoice.paid == true then
      Display a dialog box reporting the that invoice is already paid.
    else
    Format the invoice and send it to the printer
  else
    Display dialog box reporting the syntax error
while (check_invoice(invoice_number) == invalid)
Return the accounting menu

3.2.1 Quarterly Report
- Called by:
  - Account Menu
- Calls:
  - Generate Accounting Report
  - Display Accounting Report
  - Print Accounting Report
- Calling Sequence:
  1. Generate Accounting Report
  2. Display Accounting Report
  3. Print Accounting Report ( If requested )
- Input:
  - None
- Output:
  - None
- Errors:
  - Not enough data to make a quaertly report
- Description:
  - This function calls the Generate Accounting Report for the last 3 months. It then displays the report to the screen with the option to print it.
- Pseusodcode:
```
Call Generate Report with the start and end dates for the Quarter
Display the Quarterly report to the user in a text box.
Display the dialog box asking the user if they want to print the report
If the dialog box returned yes
  Send the report to the printer
Return to the accounting menu
        
```
3.2.2 Date to Date Report
- Called by:
  - Accounting Menu
- Calls:
  - Get Report Dates
  - Check Report Dates
  - Generate Accounting Report
  - Display Accounting Report
  - Print Accounting Report
- Calling Sequence:
  1. Get Report Dates
  2. Check Report Dates
  3. Generate Accounting Report
  4. Display Accounting Report
  5. Print Accounting Report ( If requested )
- Input:
  - None
- Output:
  - None
- Errors:
  - Invalid date format for either date
  - The start date is less than the ending date
  - We don't have the data for the start or end date
- Description:
  - This function prompts the user for a starting and ending date for the report. It then checks to make sure that the dates are valid and the starting date is less than the ending date. It calls Generate Accounting Report with the two dates to generate the report.
- Pseusodcode:
```
do
  Display a text box to the user to get the start and end date
while (start date is invalid OR end date is invalid)
Call Generate Report with the start and end dates
Display the report to the user in a text box
Display the dialog box asking the user if they want to print the report
If the dialog box returned yes
  Send the report to the printer
Return to the accounting menu
        
```
3.2.3 Generate Accounting Report
- Called by:
  - Quarterly Report
  - Date to Date Report
- Calls:
  - Get Invoices ( start date, end date)
- Calling Sequence: (None)
- Input:
  - Starting date
  - Ending Date
- Output:
  - A formated Invoice report
- Errors:
  - None
- Description:
  - This function is passed the starting and ending dates of the report. It queries the invoice datastore for all the invoices between the dates and generates the report.
- Pseusodcode:
```
Get the list of invoices from the Invoices datastore.
For each record in the list
   Next record if the date is before the start date or after the end date
   found = found + 1
   Add the record data to the room type total
if found equals 0
  Display a dialog box reporting that there is no data for the report
Generate the report from the totaled data and return it to the calling
  function
        
```

3.2.4 Unpaid Invoice Report

Called by:
- Account Menu

Calls:
- Get Unpaid Invoices
- Display Report
- Print Report ( If requested )

Calling Sequence:
1. Get Unpaid Invoices
2. Display Report
3. Print Report ( If requested )

Input:
- None

Output:
- None

Errors:
- No unpaid invoices

Description:
- This function generates a report which lists all the unpaid invoices. It is displayed to the screen and the user can print it out if they want.

Pseusodcode:

Get the list of invoices from the Invoices datastore.
For each record in the list
   Next record if the invoice is paid
   Add the record to the display list
If the display list is empty
  Display a dialog box reporting that all invoices are paid
else
  Display A dialog box to the user asking if they want to print the report
  If the dialog return yes
    Send the display list to the printer
Return the the accounting menu