From: Jonathan Prykop <jonathan@freeside.biz>
Date: Thu, 12 Mar 2015 00:26:03 +0000 (-0500)
Subject: documentation for FS::pay_batch::import_results, cuz I was tracing it anyway
X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=771e64b732c69902be5552d53d4a7a1199d5fca3

documentation for FS::pay_batch::import_results, cuz I was tracing it anyway
---

diff --git a/FS/FS/pay_batch.pm b/FS/FS/pay_batch.pm
index fcf1a5a54..f41b3e38b 100644
--- a/FS/FS/pay_batch.pm
+++ b/FS/FS/pay_batch.pm
@@ -220,6 +220,36 @@ I<format> - an L<FS::pay_batch> module
 I<gateway> - an L<FS::payment_gateway> object for a batch gateway.  This 
 takes precedence over I<format>.
 
+Supported format keys (defined in the specified FS::pay_batch module) are:
+
+I<filetype> - CSV, fixed, variable, XML
+
+I<fields> - list of field names for each row/line
+
+I<formatre> - regular expression for fixed filetype
+
+I<parse> - for variable filetype
+
+I<xmlkeys> - for XML filetype
+
+I<xmlrow> - for XML filetype
+
+I<begin_condition> - sub, ignore all lines before this returns true
+
+I<end_condition> - sub, stop processing lines when this returns true
+
+I<end_hook> - sub, runs immediately after end_condition returns true
+
+I<skip_condition> - sub, skip lines when this returns true
+
+I<hook> - sub, runs before approved/declined conditions are checked
+
+I<approved> - sub, returns true when approved
+
+I<declined> - sub, returns true when declined
+
+I<close_condition> - sub, decide whether or not to close the batch
+
 =cut
 
 sub import_results {