Versions Compared

Old Version 3

changes.mady.by.user Tyson Phillips

Saved on

compared with

New Version 4

changes.mady.by.user Jonathan Reissmueller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
hiddentrue

How to generate reports, and create custom reports.


Table of Contents
Table of Contents
maxLevel4
outlinetrue
classtoc

About Reports

Reports can contain information on just about anything. Blesta includes a few helpful reports by default. You can access these under [Billing] > [Reports].

Default Reports

NameDescriptionFormatsSince Version
Aging InvoicesUnpaid invoices over the last 30, 60, and 90+ days.CSV, JSON
Client Data PortabilityAll non-sensitive information pertaining to a client.JSON4.3
Custom ReportOne of the various custom reports added to the system.CSV, JSON
Invoice CreationInvoices based on the date they were generated.CSV, JSON
Tax LiabilityTaxes collected.CSV, JSON
Transactions AppliedPayments applied to invoices.CSV, JSON
Transactions ReceivedPayments received.CSV, JSON
Package RevenueCalculates revenue from a currency for each package by totaling the paid invoice line items associated with the package.CSV, JSON4.9

Custom Reports

Blesta includes some really helpful default reports, but some organizations require detailed custom reports. Custom reports can be created under [Billing] > [Reports] > [Customize], and allow you to specify any number of fields you wish to collect from a user that generates the custom report.

...

To add a custom report, click the Add Report button under [Billing] > [Reports] > [Customize].

OptionDescription
NameThe name of your custom report.
Query

The SQL query to be executed when your report is requested.

Info

Fields can be used within a query using the colon syntax. For example:

Code Block
languagesql
SELECT `id` FROM `users` WHERE `username`=:username;

Where a field exists with the name username.


Fields


OptionDescription
LabelThe label shown for this field when generating this report.
NameThe name of the field for use in query substitution.
Type

The type of field.

OptionDescription
TextA text input field.
SelectA select menu, with the provided options.
DateA date picker.


Required

Whether or not the field is required.

OptionsDescription
NoThe field is not required.
YesThe field is required to have something specified. For select field types, one of the specified options must be selected.
Custom RegexThe value for the field must pass this regular expression.



Editing a Custom Report

To edit a custom report, click the Edit link next to the report you wish to update under [Billing] > [Reports] > [Customize].

...

To delete a custom report, click the Delete link next to the report you wish to remove under [Billing] > [Reports] > [Customize].