Moab Accounting Manager > Appendices > Appendix A: Commands Reference > gstatement

gstatement

Synopsis

gstatement [[-f] <fund_id>] [-n <fund_name>] [-u <user_name>] [-g <group_name>] [-a <account_name>] [-o <organization_name>] [-c <class_name>] [-m <machine_name>] [--filter <filter_name>=<filter_value>]... [--filter-type <filter_type>] [-s <start_time>] [-e <end_time>] [--summarize] [-h, --hours] [--debug] [--site <site_name>] [--help] [--man] [--version]

Overview

gstatement displays a fund statement. For a specified time frame it displays the beginning and ending balances as well as the total credits and debits to the fund over that period. This is followed by an itemized report of the debits and credits. You can use filters to select the funds you would like to review.

Options

-a
Format	-a <account_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this account. Note that the statement may include information from other accounts if multiple accounts share the included funds.

-c
Format	-c <class_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this class. Note that the statement may include information from other classes if multiple classes share the included funds.

-e
Format	-e <end_time>
Default	Now
Description	Specifies the end of the reporting period in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now.

-f
Format	[-f] <fund_id>
Default	Infinity
Description	Specifies that MAM should make the fund statement for the specified fund.

-g
Format	-g <group_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this group. Note that the statement may include information from other groups if multiple groups share the included funds.

-h
Format	-h or --hours
Default	---
Description	Specifies that MAM should display time-based credits in hours. In cases where the currency is measured in resource-seconds (like processor-seconds), the currency is divided by 3600 to display resource-hours.

-m
Format	-m <machine_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this machine. Note that the statement may include information from other machines if multiple machines share the included funds.

-n
Format	[-n] <fund_name>
Default	---
Description	Specifies that MAM will display the fund statement for funds with the given name.

-o
Format	-o <organization_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this organization. Note that the statement may include information from other organizations if multiple organizations share the included funds.

-s
Format	-s <start_time>
Default	-Infinity
Description	Specifies the beginning of the reporting period in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now.

-u
Format	-u <user_name>
Default	---
Description	Specifies that the statement will represent a combination of information for all the funds available for this user. Note that the statement may include information from other users if multiple machines share the included users.

--debug
Format	--debug
Default	---
Description	Logs debug information to the screen.

--filter
Format	--filter <filter_name>=<filter_value>
Default	---
Description	Restricts the fund to one where constraints do not conflict with the specified filters. For example, gstatement --filter User=amy will restrict the fund to one usable by the user amy. You may specify multiple filter options that are logically ANDed together.

--filter-type
Format	--filter-type <filter_type>
Default	NonExclusive
Description	Specifies the filtering type. If you use the Exclusive filter type, MAM will only match a fund if the specified filters meet all constraints. If you use the NonExclusive filter type, MAM will match a fund as long as the specified filters do not conflict with the constraints.

--help
Format	--help
Default	---
Description	Displays a brief help message.

--man
Format	--man
Default	---
Description	Displays full documentation.

--quiet
Format	--quiet
Default	---
Description	Suppresses headers and success messages.

--site
Format	--site <site_name>
Default	---
Description	Obtains a response from specified site.

--summarize
Format	--summarize
Default	---
Description	Displays transaction summaries only. Deposits, Refunds, Charges, and other properties will be shown as total as opposed to being itemized.

--version
Format	--version
Default	---
Description	Displays the product version.