summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Davis <jeremyd@freeside.biz>2015-02-11 14:30:00 -0500
committerJeremy Davis <jeremyd@freeside.biz>2015-02-11 14:30:00 -0500
commit56fabf7ddfea7308bb22e43b79df04dd46a1620f (patch)
tree69665fe033a73680aa52b65d4d08d3b277e8368d
parent60713e5d1ac1775194b87486b3c73f27de4eb63d (diff)
Document bill now API
-rw-r--r--FS/FS/API.pm17
-rw-r--r--bin/xmlrpc-customer_bill_now21
2 files changed, 36 insertions, 2 deletions
diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index 994f8ba70..9b5783a46 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -749,8 +749,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
diff --git a/bin/xmlrpc-customer_bill_now b/bin/xmlrpc-customer_bill_now
new file mode 100644
index 000000000..244b66f06
--- /dev/null
+++ b/bin/xmlrpc-customer_bill_now
@@ -0,0 +1,21 @@
+#!/usr/bin/perl
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my $uri = new URI 'http://localhost:8008/';
+
+my $server = new Frontier::Client ( 'url' => $uri );
+
+my $result = $server->call(
+ 'FS.API.bill_now',
+ 'secret' => 'sharingiscaring',
+ 'custnum' => 3,
+);
+
+#die $result->{'error'} if $result->{'error'};
+
+print Dumper($result);
+
+1;