{
 "openapi": "3.1.0",
 "info": {
  "title": "Pay Groups (HRMS)",
  "version": "20261030b",
  "description": "Who is paid together, how often, and which engine calculates them."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "pay-groups": {
    "type": "object",
    "required": [
     "code",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "pay_frequency": {
      "type": "string",
      "description": "Frequency"
     },
     "calculation_mode": {
      "type": "string",
      "description": "Calculated by",
      "enum": [
       "internal",
       "external_tax",
       "outsourced"
      ]
     },
     "tax_engine_id": {
      "type": "string",
      "format": "uuid",
      "description": "Tax engine id"
     },
     "payroll_engine_id": {
      "type": "string",
      "format": "uuid",
      "description": "Payroll engine id"
     },
     "legal_entity": {
      "type": "string",
      "description": "Legal entity"
     },
     "employer_ein": {
      "type": "string",
      "description": "Employer tax reference"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "establishment_id": {
      "type": "string",
      "description": "MHRSD establishment number"
     },
     "payer_bank_code": {
      "type": "string",
      "description": "Paying bank (SARIE code)"
     },
     "payer_iban": {
      "type": "string",
      "description": "Paying account IBAN"
     },
     "overtime_rule_id": {
      "type": "string",
      "format": "uuid",
      "description": "Overtime rule"
     },
     "fund_id": {
      "type": "string",
      "format": "uuid",
      "description": "Fund id"
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/pay-groups": {
   "get": {
    "summary": "list pay-groups",
    "operationId": "list_pay_groups_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create pay-groups",
    "operationId": "create_pay_groups_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/pay-groups/{id}": {
   "get": {
    "summary": "get pay-groups",
    "operationId": "get_pay_groups_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change pay-groups",
    "operationId": "change_pay_groups_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete pay-groups",
    "operationId": "delete_pay_groups_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/pay-groups/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_pay_groups_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/pay-groups/{id}/calendar": {
   "post": {
    "summary": "Calendar",
    "operationId": "action_pay_groups_0_6",
    "description": "Body keys: year, firstPeriodStart*, payDateOffsetDays, cutoffDaysBefore",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}