Zoca

Zoca Compensation API

The Compensation API from Zoca — 9 operation(s) for compensation.

GitHub OpenAPI

Operations 12

GET /compensation/refund-allocation/preview/{saleId} Preview how a refund splits across sale lines #
GET /compensation/settings/{locationEntityId} Get commission calculation settings for a location #
PUT /compensation/settings/{locationEntityId} Update commission calculation settings #
GET /compensation/rules/{memberLocationId} Get commission rule history for a staff member #
POST /compensation/rules/{memberLocationId} Create a new effective-dated commission rule #
GET /compensation/overrides/{memberLocationId} Get commission rate overrides #
POST /compensation/overrides/{memberLocationId} Add or replace a commission rate override #
DELETE /compensation/overrides/{overrideId} End a commission rate override #
PUT /compensation/pay-config/{memberLocationId} Update hourly / fixed pay / greater-of settings #
GET /compensation/adjustments/{memberLocationId} List manual pay adjustments #
POST /compensation/adjustments Record a manual pay adjustment #
DELETE /compensation/adjustments/{adjustmentId} Remove a manual pay adjustment #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-compensation-api-openapi.yml

Other Resources

🔗
Components
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/components/zoca-components.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoca-compensation-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoca-compensation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoca Platform Compensation API
  description: 'The Zoca platform API behind the Zoca web app and mobile apps: scheduling, website generation, Google Business Profile, discovery/local SEO, social media, booking enquiries, offers, clients, staff, billing and the Zoca "brain" agent layer.'
  version: 3.20.10
  contact: {}
  x-apievangelist-note: Harvested verbatim from https://api.zoca.ai/swagger.json. The provider ships the default NestJS Swagger metadata (title "API Documentation", empty servers[]); title/description/servers were set by API Evangelist for identification and the unmodified original is preserved at openapi/_original/zoca-platform-swagger.json. Every path, operation, summary, parameter and response is exactly as published.
servers:
- url: https://api.zoca.ai
  description: Production
tags:
- name: Compensation
paths:
  /compensation/refund-allocation/preview/{saleId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Preview how a refund splits across sale lines
      tags:
      - Compensation
  /compensation/settings/{locationEntityId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get commission calculation settings for a location
      tags:
      - Compensation
    put:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Update commission calculation settings
      tags:
      - Compensation
  /compensation/rules/{memberLocationId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get commission rule history for a staff member
      tags:
      - Compensation
    post:
      operationId: t_value
      parameters: []
      responses:
        '201':
          description: ''
      summary: Create a new effective-dated commission rule
      tags:
      - Compensation
  /compensation/overrides/{memberLocationId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get commission rate overrides
      tags:
      - Compensation
    post:
      operationId: t_value
      parameters: []
      responses:
        '201':
          description: ''
      summary: Add or replace a commission rate override
      tags:
      - Compensation
  /compensation/overrides/{overrideId}:
    delete:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: End a commission rate override
      tags:
      - Compensation
  /compensation/pay-config/{memberLocationId}:
    put:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Update hourly / fixed pay / greater-of settings
      tags:
      - Compensation
  /compensation/adjustments/{memberLocationId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: List manual pay adjustments
      tags:
      - Compensation
  /compensation/adjustments:
    post:
      operationId: t_value
      parameters: []
      responses:
        '201':
          description: ''
      summary: Record a manual pay adjustment
      tags:
      - Compensation
  /compensation/adjustments/{adjustmentId}:
    delete:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Remove a manual pay adjustment
      tags:
      - Compensation
components:
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      name: Authorization
      description: Enter JWT token in the format Bearer <token>
      in: header