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

Reporting Transactions

All transaction reports found in the Billing Circle system can be queried through the API. Note that there is no 'testmode' for reporting. See Understanding Responses for response details.

Field	Required	Value	Max Length	Description
method	Required	reporting	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	Optional/Conditional	Any unique value	255	*If you wish to restrict the reports to a particular client.* The "merchantid" allows a merchant to refer to a client record by their own proprietary key as defined within their database. For all methods, excluding createclient, the "merchantid" can be omitted if the "clientid" is submitted. Each client record must have a unique merchantid.
c_clientid	Optional/Conditional	Integer	N/A	*If you wish to restrict the reports to a particular client.*The "clientid" is the key created by Billing Circle to refer to a client record. It is returned by Billing Circle after processing a successful createclient request. For all methods, excluding createclient (where a "clientid" is not applicable), the "clientid" can be omitted if the "merchantid" is submitted.
r_startdate	Required	YYYY-MM-DD	10	Reporting start date.
r_enddate	Required	YYYY-MM-DD	10	Reporting end date.
r_chargetype	Required	net,gross,credits	N/A	Type of transactions. Net is sum of charges and credits. Gross is charges only.
r_groupby	Required	day, week, month, quarter, year, client, schedule, state, country, transaction	10	Field to group by / Type of report to run. Based in this field, differing number of columns will be returned.

• 

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