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

Create Adjustment

The createadjustment adds a billing adjustment to a billing schedule. Billing Adjustments modify the amount charged a client on their next bill. Using this method the merchant may increase or decrease the amount charged to the client for the next billing. To decrease the client's bill enter a negative number (ex: -1.99). If the sum of adjustments causes the billing schedule to go below $0.00 an error will be returned and the billing adjustment will not be added.

Field	Required	Value	Max Length	Description
method	Required	createadjustment	N/A	Indicates the function the merchant wishes to perform.
companyid	Required	Varies by merchant	30	Issued by Billing Circle.
username	Required	Varies by merchant	30	Any Admin level account defined within Billing Circle.
password	Required	Varies by merchant	100	Password associated with username field.
c_merchantid	Conditional	Any unique value	255	The "merchantid" allows a merchant to refer to a client record by their own proprietary key as defined within their database. This value is required if a "clientid" is not submitted.
c_clientid	Conditional	Integer	N/A	The "clientid" is an integer value returned after a successful createclient post. This value is required if a "merchantid" is not submitted.
s_scheduleid	Required	Integer	N/A	The scheduleid is the value returned after a successful createschedule submission. This value must be stored and will be used for all future reference to this billing schedule.
s_adjustment	Optional	Double	N/A	Defines an additional one time charge associated with the billing schedule. Often used for startup fees. This charge is added to the schedule's first billing cycle total.
s_adjustmentnote	Conditional	Any String	255	A short note explaining the s_adjustment fee. Notes show on the receipt emails optionally sent to clients.

• 

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