PaySpace integration

SA payroll (Deel): employees, payroll data, leave, company structure

Help CentreConnectors

Overview

PaySpace (acquired by Deel) is a South African + African payroll + HR platform – payroll runs, employees, leave, attendance. The Automize PaySpace connector covers employees, companies, payslips, departments, and leave types.

  • Regions: Headquartered in SA, payroll engines for many African countries (SA, KE, NG, BW, NA, MZ, AO, MU, GH, UG, TZ, ZW, etc.).
  • Plans: Standard, Premium, Enterprise – API on Premium+.

Setting up the connection

Auth type: OAuth 2.0 (Client Credentials).

  1. Contact your PaySpace account manager to enable API access.
  2. PaySpace provides Client ID + Client Secret for OAuth Client Credentials.
  3. In Automize, open Settings → Connectors → PaySpace → Add connection. Paste credentials + environment (production / staging).

Find your credentials at https://www.payspace.com/.


Rate limits

Per-tenant limits. Connector retries 429 with backoff.


Data model

Payroll primitives:

    Company (legal entity) ─┬─ Departments
                            ├─ Employees ─── Payslips (per period)
                            └─ Leave Types

Available operations

8 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Create employeeGeneralCreate a new employee record in PaySpace.
Get employeeGeneralGet employee details by ID from PaySpace.
Get payslipGeneralGet payslip data for an employee and period from PaySpace.
List companiesGeneralList accessible companies in PaySpace.
List departmentsGeneralList departments in PaySpace.
List employeesGeneralList employees in a company via PaySpace.
List leave typesGeneralList leave type definitions in PaySpace.
Update employeeGeneralUpdate employee details in PaySpace.

Operations

Create employee

Create a new employee record in PaySpace.

ParameterRequiredTypeDescription
Employee data (JSON) fieldsYestextarea

Tips

  • fields: structured object with personal + employment + tax + banking info.
  • PaySpace requires SA-specific fields (ID number, tax reference) for SA employees.

Get employee

Get employee details by ID from PaySpace.

ParameterRequiredTypeDescription
Employee ID employee_idYestext

Tips

  • employee_id. Returns full profile + payroll info + tax details.

Get payslip

Get payslip data for an employee and period from PaySpace.

ParameterRequiredTypeDescription
Employee ID employee_idYestext
Pay period periodNotext

Tips

  • employee_id + period (YYYY-MM). Returns gross/net/deductions breakdown.

List companies

List accessible companies in PaySpace.

No input parameters.

Tips

  • Returns companies you have access to. One PaySpace tenant may have multiple companies (separate legal entities).

List departments

List departments in PaySpace.

No input parameters.

Tips

  • Departments per company. Used for cost-center reporting.

List employees

List employees in a company via PaySpace.

No input parameters.

Tips

  • Filter by company_id. Filter by status (active, terminated).

List leave types

List leave type definitions in PaySpace.

No input parameters.

Tips

  • Leave categories (annual, sick, family, etc.). Each has an annual entitlement.

Update employee

Update employee details in PaySpace.

ParameterRequiredTypeDescription
Employee ID employee_idYestext
Fields (JSON) fieldsYestextarea

Tips

  • PATCH-style on fields. Termination dates flow through payroll automatically.

FAQ

PaySpace + Deel – same?
Deel acquired PaySpace. Currently still separate products + APIs. Migration to a unified API may happen – track Deel's announcements.
SA-specific compliance?
PaySpace handles UIF, PAYE, SDL, Workmen's Compensation, EMP201/501 filings. Required fields like SA ID number + tax reference enforced on Create Employee.
Sandbox?
Yes – staging environment available. Set environment=staging on the connection.

Related connectors

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.