Transaction Endpoint
Transactions API access is read-only
Note: API Access is limited to Enterprise accounts and available upon request
Overview
The Transactions API allows Enterprise accounts to retrieve a paginated list of their transactions for a selected time period, including the receipt number, date/time, client, item name, price, tax, discount, qty, type (i.e. Service, Product etc.), User.
Endpoint
POST https://my.simplespa.com/api/transactions.php
Authentication
You must include a valid Authorization header using your SimpleSpa API Key:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Replace YOUR_API_KEY with your SimpleSpa Enterprise API Key.
Request Body
Field
Type
Required
Description
start
string
Yes
Start date in YYYY-MM-DD format
end
string
Yes
End date in YYYY-MM-DD format
page
integer
No
Page number (default: 1)
per_page
integer
No
Results per page (default: 1000 maximum)
Example Request
curl -X POST https://my.simplespa.com/api/transactions.php \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"start": "2025-06-01",
"end": "2025-06-30",
"page": 1,
"per_page": 10
}'
Example Response
{
"success": true,
"start": "2025-06-01",
"end": "2025-06-30",
"total_results": 2,
"transactions": [
{
"receipt_id": "R-9582",
"timestamp": "2025-06-05 14:22:11",
"client": "John Doe",
"description": "Swedish Massage",
"amount": 85.00,
"tax": 6.80,
"discount": 10.00,
"qty": 1,
"type": "Service",
"user": "[email protected]"
},
{
"receipt_id": "R-9583",
"timestamp": "2025-06-05 14:34:08",
"client": "WALKIN",
"description": "Lavender Body Oil",
"amount": 24.00,
"tax": 1.92,
"discount": 0.00,
"qty": 1,
"type": "Product",
"user": "[email protected]"
}
]
}
Notes
Important: for polling-based setup, all new records will be fetched together, which could lead to duplication unless filtered appropriately, please keep a record of those that have been contacted if you are using this for notifications
Limitation: Start/End date can range up to 92 days
Pagination: Default per_page is 100 if not specified. Maximum allowed is 1000 per page.
Rate Limiting: Please ensure reasonable usage to avoid throttling. It is recommended to poll no faster than once per minute.
⚠️ IMPORTANT: Never expose your private API key in client-side JavaScript. Always use secure, server-side code to handle sensitive credentials.
Last updated