Freeside:3:Documentation:Developer/FS/API - Revision history

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-09-28T14:14:16Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-04-10T17:56:47Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-03-30T18:47:51Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-03-24T15:37:33Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-03-24T14:27:55Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-02-11T19:34:05Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-02-10T13:29:02Z

Edit via perl MediaWiki framework (1.13)

Show changes

Jeremyd: Edit via perl MediaWiki framework (1.13)

2015-02-10T13:24:53Z

Edit via perl MediaWiki framework (1.13)

Jeremyd: Edit via perl MediaWiki framework (1.13)

2014-06-27T21:31:14Z

Edit via perl MediaWiki framework (1.13)

Show changes

Jeremyd at 17:52, 31 March 2014

2014-03-31T17:52:31Z

@@ Line 9: / Line 9: @@
 This module implements a backend API for advanced back-office integration.
-In contrast to the self-service API, which authenticates an end-user and offers functionality to that end user, the backend API performs a simple shared-secret authentication and offers full, administrator functionality, enabling integration with other back-office systems.
+In contrast to the self-service API, which authenticates an end-user and offers functionality to that end user, the backend API performs a simple shared-secret authentication and offers full, administrator functionality, enabling integration with other back-office systems. Only ccess this API from a secure network from other backoffice machines. DON'T use this API to create customer portal functionality.
 If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block the port by default, only allow access from back-office servers with the same security precations as the Freeside server, and encrypt the communication channel (for example, with an SSH tunnel or VPN) rather than accessing it in plaintext.

@@ Line 141: / Line 141: @@
 :; invoicing_list
 ::comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 184: / Line 194: @@
 ::Mobile number
 :; invoicing_list
-::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
+::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses)
 :; referral_custnum
 ::Referring customer number
@@ Line 191: / Line 211: @@
 :; agentnum
 ::Agent number
-; customer_info OPTION => VALUE, ...
+; customer_info
 :Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret
 ; location_info

@@ Line 141: / Line 141: @@
 :; invoicing_list
 ::comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 194: / Line 184: @@
 ::Mobile number
 :; invoicing_list
-::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses)
+::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 211: / Line 191: @@
 :; agentnum
 ::Agent number
-; customer_info
+; customer_info OPTION => VALUE, ...
 :Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret
 ; location_info

@@ Line 141: / Line 141: @@
 :; invoicing_list
 ::comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 184: / Line 194: @@
 ::Mobile number
 :; invoicing_list
-::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
+::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses)
 :; referral_custnum
 ::Referring customer number
@@ Line 191: / Line 211: @@
 :; agentnum
 ::Agent number
-; customer_info OPTION => VALUE, ...
+; customer_info
 :Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret
 ; location_info

@@ Line 141: / Line 141: @@
 :; invoicing_list
 ::comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 194: / Line 184: @@
 ::Mobile number
 :; invoicing_list
-::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses)
+::Comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
 :; referral_custnum
 ::Referring customer number
@@ Line 211: / Line 191: @@
 :; agentnum
 ::Agent number
-; customer_info
+; customer_info OPTION => VALUE, ...
 :Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret
 ; location_info

← Older revision		Revision as of 19:34, 11 February 2015
Line 218:		Line 218:
	:Bills a single customer now, in the same fashion as the "Bill now" link in the UI.		: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:
		+	:; secret
		+	::API Secret (required)
		+	:; custnum
		+	::Customer number (required)

← Older revision		Revision as of 13:24, 10 February 2015
Line 1:		Line 1:
−	~~==NAME==~~
−	~~FS::API - Freeside backend API~~

−	~~==SYNOPSIS==~~
−	~~<code>~~
−	~~use FS::API;~~
−	~~</code>~~
−	~~==DESCRIPTION==~~
−	~~This module implements a backend API for advanced back-office integration.~~
−
−	In contrast to the self-service API, which authenticates an end-user and offers functionality to that end user, the backend API performs a simple shared-secret authentication and offers full, administrator functionality, enabling integration with other back-office systems.
−
−	If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block the port by default, only allow access from back-office servers with the same security precations as the Freeside server, and encrypt the communication channel (for exampple, with an SSH tunnel or VPN) rather than accessing it in plaintext.
−
−	~~==METHODS==~~
−	~~; insert_payment~~
−	~~:Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:~~
−	~~:; secret~~
−	~~::API Secret~~
−	~~:; custnum~~
−	~~::Customer number~~
−	~~:; payby~~
−	~~::Payment type~~
−	~~:; paid~~
−	~~::Amount paid~~
−	~~:; _date~~
−	~~::Option date for payment~~
−
−	~~::Example:~~
−	~~<code>~~
−	~~my $result = FS::API->insert_payment(~~
−	~~'secret' => 'sharingiscaring',~~
−	~~'custnum' => 181318,~~
−	~~'payby' => 'CASH',~~
−	~~'paid' => '54.32',~~
−
−	~~#optional~~
−	~~'_date' => 1397977200, #UNIX timestamp~~
−	);
−
−	~~if ( $result->{'error'} ) {~~
−	~~die $result->{'error'};~~
−	~~} else {~~
−	~~#payment was inserted~~
−	~~print "paynum ". $result->{'paynum'};~~
−	}
−	~~</code>~~
−	~~; insert_credit~~
−	~~:Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys~~
−	~~:; secret~~
−	~~::API Secret~~
−	~~:; custnum~~
−	~~::customer number~~
−	~~:; amount~~
−	~~::Amount of the credit~~
−	~~:; _date~~
−	~~::The date the credit will be posted~~
−
−	~~::Example:~~
−	~~<code>~~
−	~~my $result = FS::API->insert_credit(~~
−	~~'secret' => 'sharingiscaring',~~
−	~~'custnum' => 181318,~~
−	~~'amount' => '54.32',~~
−
−	~~#optional~~
−	~~'_date' => 1397977200, #UNIX timestamp~~
−	);
−
−	~~if ( $result->{'error'} ) {~~
−	~~die $result->{'error'};~~
−	~~} else {~~
−	~~#credit was inserted~~
−	~~print "crednum ". $result->{'crednum'};~~
−	}
−	~~</code>~~
−	~~; insert_refund~~
−	~~:Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund~~
−
−	~~:Example:~~
−	~~<code>~~
−	~~my $result = FS::API->insert_refund(~~
−	~~'secret' => 'sharingiscaring',~~
−	~~'custnum' => 181318,~~
−	~~'payby' => 'CASH',~~
−	~~'refund' => '54.32',~~
−
−	~~#optional~~
−	~~'_date' => 1397977200, #UNIX timestamp~~
−	);
−
−	~~if ( $result->{'error'} ) {~~
−	~~die $result->{'error'};~~
−	~~} else {~~
−	~~#refund was inserted~~
−	~~print "refundnum ". $result->{'crednum'};~~
−	}
−	~~</code>~~
−	~~; new_customer~~
−	~~:Creates a new customer. Takes a hash reference as parameter with the following keys:~~
−	~~:; secret~~
−	~~::API Secret~~
−	~~:; first~~
−	~~::first name (required)~~
−	~~:; last~~
−	~~::last name (required)~~
−	~~:; ss~~
−	~~::(not typically collected; mostly used for ACH transactions)~~
−	~~:; company~~
−	~~::Company name~~
−	~~:; address1 (required)~~
−	~~::Address line one~~
−	~~:; city (required)~~
−	~~::City~~
−	~~:; county~~
−	~~::County~~
−	~~:; state (required)~~
−	~~::State~~
−	~~:; zip (required)~~
−	~~::Zip or postal code~~
−	~~:; country~~
−	~~::2 Digit Country Code~~
−	~~:; latitude~~
−	~~::latitude~~
−	~~:; Longitude~~
−	~~::longitude~~
−	~~:; geocode~~
−	~~::Currently used for third party tax vendor lookups~~
−	~~:; censustract~~
−	~~::Used for determining FCC 477 reporting~~
−	~~:; censusyear~~
−	~~::Used for determining FCC 477 reporting~~
−	~~:; daytime~~
−	~~::Daytime phone number~~
−	~~:; night~~
−	~~::Evening phone number~~
−	~~:; fax~~
−	~~::Fax number~~
−	~~:; mobile~~
−	~~::Mobile number~~
−	~~:; invoicing_list~~
−	::comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), postal_invoicing Set to 1 to enable postal invoicing
−	~~:; payby~~
−	~~::CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY~~
−	~~:; payinfo~~
−	~~::Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL~~
−	~~:; paycvv~~
−	~~::Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)~~
−	~~:; paydate~~
−	~~::Expiration date for CARD/DCRD~~
−	~~:; payname~~
−	~~::Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK~~
−	~~:; referral_custnum~~
−	~~::referring customer number~~
−	~~:; agentnum~~
−	~~::Agent number~~
−	~~:; agent_custid~~
−	~~::Agent specific customer number~~
−	~~:; referral_custnum~~
−	~~::Referring customer number~~
−	~~; customer_info~~
−	~~:Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret~~
−	~~; location_info~~
−	~~:Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret~~

← Older revision		Revision as of 17:52, 31 March 2014
Line 126:		Line 126:
	:; paid		:; paid
	::Amount paid		::Amount paid
		+	<br>
		+	== Bugs ==