• NAME
• SYNPOSIS
• DESCRIPTION
• CRITERIA PROPERTIES
• ACTION PROPERTIES
• INTERNALS
  • columns
  • header_lines
  • name
• METHODS
• LICENSE AND COPYRIGHT

NAME

LedgerSMB::Report::Invoices::Payments - Payment Search Report for LedgerSMB

SYNPOSIS

 my $report = LedgerSMB::Report::Invoices::Payments->new(%$request);
 $report->render();

DESCRIPTION

This class provides routines for searching payments and displaying the report in the standard supported reporting formats.

CRITERIA PROPERTIES

entity_class

1 for vendor, 2 for customer.

meta_number

Customer or vendor account number, prefix search

cash_accno

Cash account number, exact match

source

Source field, prefix search

ACTION PROPERTIES

This report is sometimes used when searching for payments to reverse payments. We allow related data to be set here. This is to be passed on to the next stage of the reversal process.

batch_id

ID of batch used. If this is not set we assume we are not reversing payments.

curr

Currency used. If not set, we assume that this is the default currency (and exchange rate of 1).

exchange_rate

Exchange rate for reversal. If not set, we use 1 if the currency is the default currency. If not, we pull the existing exchange rate for the reversal date, and if this is not set, an error will be returned during the reversal process.

INTERNALS

columns

header_lines

meta_number

Customer or vendor number

date_from

Start date

date_to

End date

name

Either "Payment Results" or "Receipt Results" depending on entity_class

METHODS

run_report

Runs the report and sets $self->rows

LICENSE AND COPYRIGHT

Copyright (C) 2018 The LedgerSMB Core Team

This file is licensed under the GNU General Public License version 2, or at your option any later version. A copy of the license should have been included with your software.