Developer Information

• Introduction

• Customer Self Service
• Callback URL
• Billing Circle Connect API
  • Understanding Bill Types

Connect API

• API Introduction
• Client Records
  • Create Client
  • Confirm Client
  • Modify Client
  • Delete Clients
  • Create Note
  • Verify Client Billing
  • Check Client Status
  • Fetch Client Data
  • Search Client Data
• Billing Schedules
  • Create Schedule
  • Confirm Schedule
  • Modify Schedule
  • Delete Schedule
  • Create Adjustment
  • Check Schedule Status
  • Fetch Schedule Data
• Reporting Data
  • Report Transactions
  • Report Due
• Understanding Responses
  • Response Codes

Resources

• Sample Code

Self Service

Billing Circle offers a simple, customizable, frontend allowing your customers immediate access to their billing information and profile. Customers may view their billing history and schedules, contact you via support tickets, or manage their profile and credit card information. The look and feel may be modified through the Billing Circle interface. Visit the Self Service page under Settings in your account and the Billing Circle documentation for more details.

Self Service URL

By default the Self Service url is https://www.accounthistory.net

API Specific Information

It may be useful to integrate this page into a frameset within your existing customer login area, offering a seamless customer experience, or seamlessly log your client in from your own website, to avoid the client remembering multiple logins. Below are the post fields required for to host a login form or system on your website.

URL: https://www.accounthistory.net - Form method must be POST.

Field	Required	Value	Description
email	Required	Customer's email address	The email address for the customer within Billing Circle
password	Required	Customer's password	The password for the customer within Billing Circle. This was either specified specifically or automatically generated by the system.
failRedirect	Optional	Fully qualified URL	In the event that a customer logs in using incorrect credentials, they may be optionally redirected to a URL of your choice. Otherwise they are presented with the default Self Service login box and error message.

Example HTML

The following HTML shows an example of using JavaScript to log your client into our Self Service system, with prepopulated login credentials that could for instance be stored in your database.

<form method="post" action="https://www.accounthistory.net/" name="myform">
   <input type="hidden" name="email" value="yourclient@yourclient.com">
   <input type="hidden" name="password" value="yourclientspassword">
   <input type="hidden" name="failRedirect" value="http://www.yoursite.com/oops.html">
</form>

<script>
document.forms.myform.submit();
</script>

• 

• Tour
• Sign Up
• Clients
• About
• Support
• Blog
• Site Map
• © 2012 Billing Circle