summaryrefslogtreecommitdiff
path: root/FS/FS/API.pm
diff options
context:
space:
mode:
authorJeremy Davis <jeremyd@freeside.biz>2015-02-11 14:28:01 -0500
committerJeremy Davis <jeremyd@freeside.biz>2015-02-11 14:28:01 -0500
commita7d1e60f6b411c9a8daa1f654855440f59bc05ea (patch)
treec02c56a514d3366dde68e46e1cbdae81de7454aa /FS/FS/API.pm
parentff9eaa5810c2ddb8688ae573b372d760679272ed (diff)
Document bill now API
Diffstat (limited to 'FS/FS/API.pm')
-rw-r--r--FS/FS/API.pm17
1 files changed, 15 insertions, 2 deletions
diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index dd172c1..c49fb20 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -603,8 +603,21 @@ sub location_info {
Bills a single customer now, in the same fashion as the "Bill now" link in the
UI.
-Returns a hash reference with a single key, 'error'. If there is an error,
-the value contains the error, otherwise it is empty.
+Returns a hash reference with a single key, 'error'. If there is an error,
+the value contains the error, otherwise it is empty. Takes a list of keys and
+values as parameters with the following keys:
+
+=over 4
+
+=item secret
+
+API Secret (required)
+
+=item custnum
+
+Customer number (required)
+
+=back
=cut