NAME

whmcs-calc-deferred-revenue - whmcs-calc-deferred-revenue

VERSION

This document describes version 0.006 of whmcs-calc-deferred-revenue (from Perl distribution App-WHMCSUtils), released on 2019-09-19.

SYNOPSIS

Usage:

% whmcs-calc-deferred-revenue [options]

DESCRIPTION

This utility collects invoice items from paid invoices, filters eligible ones, then defers the revenue to separate months for items that should be deferred, and finally sums the amounts to calculate total monthly deferred revenues.

This utility can also be instructed (via setting the full option to true) to output the full CSV report (each items with their categorizations and deferred revenues).

Recognizes English and Indonesian description text.

Categorization heuristics:

Fund deposits are not recognized as revenues.
Hosting revenues are deferred, but when the description indicates starting and ending dates and the dates are not too old.
Domain and addon revenues are not deferred, they are recognized immediately.
Other items will be assumed as immediate revenues.

Extra rules (applied first) can be specified via the extra_rules option.

To use this utility, install the Perl CPAN distribution App::WHMCSUtils. Then, create a configuration file ~/whmcs-calc-deferred-revenue.conf containing something like:

db_name=YOURDBNAME
db_host=YOURDBHOST
db_user=YOURDBUSER
db_pass=YOURDBPASS

db_host defaults to localhost. db_user and db_pass can be omitted if you have /etc/my.cnf or ~/.my.cnf. This utility can search for username/password from those files.

You can also add other configuration like extra_rules, e.g.:

extra_rules=[{"type": "^$", "description": "^(?^i)sewa\\b.*ruang", "category": "rent"}]

You can then run the utility for the desired, e.g.:

% whmcs-calc-deferred-revenue --date-start 2013-01-01 --date-end 2017-10-31 \
    --date-old-limit 2013-01-01 --full --output-file ~/output.csv

Wait for a while and check the output at ~/output.csv.

OPTIONS

* marks required options.

Main options

--date-old-limit=s

Set what date will be considered too old to recognize item as revenue.

Default is 2008-01-01.

--db-host=s

Default value:

"localhost"

--db-name=s*

--db-pass=s

--db-port=s

Default value:

--db-user=s

--output-file=s

Configuration options

--config-path=s, -c: Set path to configuration file.
--config-profile=s, -P: Set configuration profile to use.
--no-config, -C: Do not use any configuration file.

Environment options

--no-env: Do not read environment for default options.

Filtering options

--date-end=s: End at this date (based on invoice payment date).
--date-start=s: Start from this date (based on invoice payment date).

Logging options

--debug: Shortcut for --log-level=debug.
--log-level=s: Set log level.
--quiet: Shortcut for --log-level=error.
--trace: Shortcut for --log-level=trace.
--verbose: Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef

--full

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]

Rule options

--extra-rules-json=s

See --extra-rules.

--extra-rules=s

Example (in JSON):

[
    {
        "type": "^$",
        "description": "^SEWA",
        "category": "rent"
    }
]

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C whmcs-calc-deferred-revenue whmcs-calc-deferred-revenue

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete whmcs-calc-deferred-revenue 'p/*/`whmcs-calc-deferred-revenue`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/whmcs-calc-deferred-revenue.conf, ~/whmcs-calc-deferred-revenue.conf, or /etc/whmcs-calc-deferred-revenue.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

date_end (see --date-end)
date_old_limit (see --date-old-limit)
date_start (see --date-start)
db_host (see --db-host)
db_name (see --db-name)
db_pass (see --db-pass)
db_port (see --db-port)
db_user (see --db-user)
extra_rules (see --extra-rules)
format (see --format)
full (see --full)
log_level (see --log-level)
naked_res (see --naked-res)
output_file (see --output-file)

ENVIRONMENT

WHMCS_CALC_DEFERRED_REVENUE_OPT => str

Specify additional command-line options.

FILES

~/.config/whmcs-calc-deferred-revenue.conf

~/whmcs-calc-deferred-revenue.conf

/etc/whmcs-calc-deferred-revenue.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-WHMCSUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-WHMCSUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-WHMCSUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install App::WHMCSUtils, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::WHMCSUtils

CPAN shell

perl -MCPAN -e shell
install App::WHMCSUtils

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Environment options

Filtering options

Logging options

Output options

Rule options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

WHMCS_CALC_DEFERRED_REVENUE_OPT => str

FILES

HOMEPAGE

SOURCE

BUGS

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions