Overview

The Sales Data API enables you to sync sales transactions from point-of-sale (POS) systems and other third-party applications with Connecteam, and to read or set per-day aggregated totals. This data can be used for reporting, analytics, dashboards, forecasting, and performance tracking.

Key Concepts

Locations

Locations represent physical branches, stores, or facilities where sales occur. Each location has:

  • A unique ID assigned by Connecteam
  • A name for identification
  • An active/inactive status

Transactions

Transactions represent individual sales events. Each transaction includes:

  • The location where the sale occurred
  • The sale type (SALE, REFUND, VOID, etc.)
  • The amount and optional tax
  • A timestamp

Daily Sales

Daily sales are per-location, per-day rollups with two values:

  • totalSales — aggregated automatically from transactions (read-only via this API; push sales using the Transactions endpoints).
  • projectedSales — a forecast / budget value you set per day via the daily-sales PUT endpoint, used for variance reporting.

Available Endpoints

Locations

MethodEndpointDescription
GET/sales/v1/locationsGet all locations
POST/sales/v1/locationsCreate a new location

Transactions

MethodEndpointDescription
POST/sales/v1/transactionsCreate transactions (up to 100)
DELETE/sales/v1/transactionsDelete transactions by time period
DELETE/sales/v1/transactions/{transactionId}Delete a single transaction

Daily Sales

MethodEndpointDescription
GET/sales/v1/daily-salesGet aggregated daily sales totals across locations
PUT/sales/v1/locations/{locationId}/daily-salesSet projected sales per day for a single location

Sale Types

Transactions support the following sale types:

TypeDescription
SALEStandard sale transaction
VOIDVoided transaction
REFUNDRefund transaction
SPLITSplit payment transaction
TRANSFERTransfer between locations
RECALLRecalled transaction
UPDATEUpdated transaction
FLOATFloat/cash management
TRANSITORYTemporary transaction
CROSS_BLCross-business line transaction
CANCELCancelled transaction
MANUALManually entered transaction

Constraints

ConstraintValue
Max transactions per request100
Max locations per GET request1000
Transaction timestampsUnix epoch (seconds)
Daily-sales datesISO 8601 (YYYY-MM-DD)

Authentication

All endpoints require authentication via API key or OAuth 2.0.

Required Scopes

ScopeOperations
sales_data.readGET locations, GET daily-sales
sales_data.writePOST locations, POST transactions, PUT daily-sales (projected)
sales_data.deleteDELETE transactions

Workflow

  1. Create locations for each store/branch
  2. Sync transactions by posting sales data with location IDs
  3. Read daily totals via the daily-sales GET endpoint for dashboards and reports
  4. Set forecasts with the daily-sales PUT endpoint for variance reporting
  5. Manage data by deleting outdated or incorrect transactions
📝

Note

You must create a location before creating transactions or setting projected sales for that location. All endpoints reference locations by their Connecteam-assigned ID.


Guide Pages

PageDescription
Managing LocationsCreate and retrieve locations
Managing TransactionsCreate and delete sales transactions
Managing Daily SalesRead aggregated daily totals and set projected (forecast) sales

API Reference