The Actuals API provides a mechanism to send transactions directly to Actuals (from the source e.g. website or mobile app where the transaction is created). By doing this as real time as possible when the transaction is created, Actuals provides companies with an independent source of expectations that can be used to match transactions against from other sources.

REST API

The Actuals (REST) API allows for real-time transaction sending by extending a company’s IT infrastructure with a small script. This script should send transactions to the Actuals platform once they are definitive. It is recommended to do this asynchronously to avoid impacting the primary workflow. The Actuals API follows a Representational State Transfer (REST) architecture.

Version 1

API details

The API is accessible over the internet and requires a specific URL, which can be obtained from your Actuals implementation consultant. It operates using HTTPS.

Request Structure

All requests to the Actuals API should be constructed with the following settings:

URL	`https://{{CUSTOMER_NAME}}.{{CUSTOMER_ID}}.api.auditservicebus.com/{{VERSION}}/{{RESOURCE}}`
Method	`POST`
Headers	`Authorization: Bearer {{TOKEN}}` `Content-Type: application/json`
Body	`{{OBJECT}}`

Fill the placeholders

{{TOKEN}}: The access token provided by your implementation consultant

{{CUSTOMER_NAME}}: Your environment name (provided by your implementation consultant)

{{CUSTOMER_ID}}: A unique ID for your company (provided by your implementation consultant)

{{VERSION}}: The version of the API to be used (provided by your implementation consultant)

{{RESOURCE}}: The type of data being sent (a list provided by your implementation consultant)

{{OBJECT}}: your data in JSON format

The full URL for your environment can be found when generating your source connection. An example curl command to send data is

json
method POST

curl --location 'https://MY_CUSTOMER_NAME.CUSTOMER_ID123.api.auditservicebus.com/1.0/RESOURCETYPETRANSACITON' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MYBEARER' \
--data '{
    "transactionid": "1923423",
    "timestamp": 2018-01-05T11:34:11Z,
    "amount": 2988
    }

The API will return 200 status code if the data is processed correctly and will return a 400 status code is the end point is not valid.

Alternative GET method

6. Actuals API

REST API

Version 1

API details

Request Structure

Version 2 (pre-release)