Overview

Overview

The BillingPlatform API is designed to operate as an extension of your standard and custom data model with basic, Database-style methods for every object utilizing Create, Retrieve, Update, Delete and Upsert operations. The “Upsert” operation allows you to specify an external key on which to either Create or Update a record based on the existence of the supplied Key. Each Web Service interaction begins with the acquisition of a session Id obtained via the log-in. Once the session is retrieved, it can be reused in subsequent operations.

These simple operations coupled with access to all of the objects in your Organization’s data model will serve as powerful building-blocks for a comprehensive web service integration. The General methods available in the web service API are described below.

General Concepts

When authoring API requests to push or pull data into or from the platform, the following concepts can be considered.

1. Updating LOOKUP type fields can be accomplished using two methods:

  • Passing the record Id of the look-up entity's record.
	{
		"brmObjects":{
			"SomeTextField":"SomeRandomText",
			"LookupFieldObj":{
				"CustomKeyField":"Unique Key Text"
			}
		}
	}

In the example above, record Id 15478 is used to populate the LOOKUP-type field. The assumption here is that the contents of the reference entity is known, particularly the needed record Id.

  • Passing the external key field value of the look-up entity's record.
	{
		"brmObjects":{
			"SomeTextField":"SomeRandomText",
			"LookupFieldObj":{
				"CustomKeyField":"Unique Key Text"
			}
		}
	}

In the second example, the reference entity has an external key field named CustomKeyField which is expected to have a unique value, "Unique Key Text". Referencing this to populate the lookup-type field will enable the use of known/user-friendly references without having to know the record Id of the reference entity's record.

2. A valid API user is needed to authenticate and retrieve a session Id/token from the platform. Reach out to your platform support contact if assistance is needed to create an API user. If administrator rights have been provided previously, a new API user can be created with the appropriate access. Refer to the How To Create an Application User article for more information.

Procedures

Integrating with the BillingPlatform API can be done through SOAP or REST. Click on one of the links below to jump to the approach that is desired.

Have more questions? Submit a request

Comments

Powered by Zendesk