Guides

Practical tutorials for integrating with the Total Access platform.

Getting started

New to Total Access? Start here:

Getting Started — Set up your API key and make your first request
Authentication — Learn API keys vs JWT tokens
Webhooks — Set up real-time event notifications

Available guides

Guide	Description
Module Context	Scope webhooks and API keys to specific modules
Industry Solutions	Available industry solutions and how to use them with the Public Data API
WhatsApp Integration	Send and receive WhatsApp Business messages
Accounting Export	Sync to Xero, QuickBooks, and Sage
Forms	Build, submit, and export custom forms
Workflows & Automations	Automate business processes with triggers
IoT Integrations	Connect and manage smart IoT devices
OAuth2 Developer Portal	Build and publish third-party apps
Payments & Billing	Manage payments, cards, and subscriptions
White Label & Branding	Customise branding and domains
Node.js SDK	Use the official Node.js SDK

Common integration patterns

Sync invoices from your system

Create an outbound webhook for invoice.created events
Store invoices in your local database
Use the API to update invoice status when paid

Import bills from email

Set up an inbound webhook for bill data
Configure your email parser to forward parsed bill data
Total Access will auto-match suppliers and route for approval

Real-time attendance sync

Subscribe to employee.clocked_in and employee.clocked_out events
Sync attendance records to your HR/payroll system
Use the API to query historical attendance data

Fleet tracking integration

Create an inbound webhook with vehicle_location type
Configure your GPS trackers to POST location updates
Use the Public Data API to query vehicle locations

Payment notification integration

Create an inbound webhook with payment_notification type
Configure your payment gateway to send notifications
Total Access matches payments to invoices automatically

Code examples

Node.js

const TotalAccess = require('totalaccess-sdk');

const client = new TotalAccess({
  apiKey: process.env.TA_API_KEY,
  environment: 'production',
});

// List recent invoices
const invoices = await client.finance.invoices.list({
  limit: 10,
  sort: 'created_at:desc',
});

// Create a webhook
const webhook = await client.webhooks.create({
  url: 'https://your-app.com/webhooks/ta',
  events: ['invoice.created', 'invoice.paid'],
});

Python

import requests

API_BASE = "https://totalaccess.co.za/api/v1"
HEADERS = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
}

# List invoices
response = requests.get(f"{API_BASE}/finance/invoices", headers=HEADERS)
invoices = response.json()["data"]

# Create a webhook
webhook = requests.post(
    f"{API_BASE}/webhooks",
    headers=HEADERS,
    json={
        "url": "https://your-app.com/webhooks/ta",
        "events": ["invoice.created", "invoice.paid"],
    },
)

cURL

# List invoices
curl -X GET https://totalaccess.co.za/api/v1/finance/invoices \
  -H "Authorization: Bearer $TA_API_KEY"

# Create a webhook
curl -X POST https://totalaccess.co.za/api/v1/webhooks \
  -H "Authorization: Bearer $TA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/ta",
    "events": ["invoice.created", "invoice.paid"]
  }'

More guides are being added. Have a specific integration scenario? Contact support and we'll add a guide for it.

Guides

On this page