Introduction

Welcome to our guide on receipting with our API package.

If you have already set up the configuration for receipting, follow this link to the available APIs in this package. Otherwise, follow the steps below to get started.

 

Getting started

The following steps are required to get started with integrating receipted data through our API package.

Once you have your security key and IDs, if required you can follow the optional steps on pushing data from iCompleat to an endpoint via our webhooks.

 

Required steps before you start using the Receipting API package Get your API security key Get your Tenant and Company ID

Optional steps for pushing data out of iCompleat Please follow the required steps on the left before attempting the bullets below Set an endpoint location Set a secret token (recommended) Receiving approval transaction data from iCompleat

 

Get your API security key

You must generate an API Security key for your account.

This is a private key and should be known only to your organisation.

Follow these steps to get your API security key.

1. On the homepage, select Configuration.
2. Select Company management.
3. Select API. 
4. On the Security Key field, select the icon to generate a key.
5. Make a note of the newly generated key or select the icon to copy to your clipboard. 

Now continue to configure an endpoint location.  

 

Generate a new key

If you are concerned your API key has been compromised, regenerate it to invalidate your key and replace it with a new one.

Follow these steps to delete your key.

1. On the homepage, select Configuration.
2. Select Company management.
3. Select API. 
4. On the Security Key field, select the icon to generate a new key.
   A new Security key is generated rendering your old key void.
5. Make a note of the newly generated key or select the icon to copy to your clipboard. 

Now advance below to get your Tenant and Company IDs.

 

Get your Tenant and Company ID

In addition to a Security key, our APIs require you to submit a Tenant ID and Company ID to access the appropriate data. 

Follow these steps to get your Tenant and Company IDs.

1. On the homepage, select Configuration.
2. Select Company management.
3. Select API. 
4. Your IDs are displayed on screen.
5. Select the icon to copy an ID to your clipboard. 

 

Optional steps for pushing receipted data from iCompleat

If you wish to use this API package to push receipting data out of iCompleat, the following steps are required to configure an endpoint location, set a secure secret token and how to respond with a journal number.

 

Configuring an endpoint location for receipted data

An endpoint is the URL where your service can be accessed by a client application. It's a requirement with our API integration to configure a location to post receipted data.

We recommend sending requests to a secured HTTPS endpoint.

Follow these steps to set an Endpoint location:

1. On the homepage, select Configuration.
2. Select Company management.
3. Select API. 
4. Simply paste your endpoint url into the dedicated fields for receipting.
5. Select Save.

For added security we recommend setting a secret token for your endpoint, see our steps on setting secret tokens below.

Otherwise, advance to Finding your Tenant and Company ID.

 

Set a secret token (recommended)

As an added level of security to your API integration, we’ve implemented a token-based authentication system which can be sent as an additional parameter in your header data. This will enable you to verify that the data has come from a trusted source.

Follow these steps to access the API page and set a Secret token code.

1. On the homepage, select Configuration.
2. Select Company management.
3. Select API. 

4. You can either:

   Option 1

   1. Use the auto-generated code in each field.  

   2. Copy the code to your clipboard using the icon. 

    

   Option 2

   1. Delete the pre-populated code from the field and type a custom code as the token instead.

   2. Copy to your clipboard using the icon.  3. Select Save.

 

 

You are now ready to go!

You should now be fully configured and have the relevant keys and IDs to use our package on integrating receipting.

Please view the section below on pushing data from iCompleat and how to acknowledge and respond with the transaction's journal number.

 

 

Receiving approved transaction data from iCompleat

Once a transaction has been fully approved in iCompleat, the transaction data will be sent automatically to your pre-configured endpoint via our webhooks.

If you haven’t added your endpoint details into iCompleat, see configuring an endpoint location to set the path which your receipted data will be sent to.

After your endpoint has received an approved transaction from iCompleat, you must acknowledge the message and respond with a journal number. The journal number will appear within iCompleat.

If a journal number is not returned to iCompleat, it will result in iCompleat recording the transaction as a posting failure. 

See POST Transaction in our API library for more information.

 

 

APIs available in this package

 

Transaction management