{
 "openapi": "3.1.0",
 "info": {
  "title": "State Programs (HRMS)",
  "version": "20261030b",
  "description": "What employees pay into in the state they work in: disability, family and paid leave, long-term care, employee unemployment — each with its own wage base, and each a line on the payslip and an entry in W-2 box 14."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "state-payroll-programs": {
    "type": "object",
    "required": [
     "tax_year",
     "state_code",
     "program_code",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "tax_year": {
      "type": "integer",
      "description": "Tax year"
     },
     "state_code": {
      "type": "string",
      "description": "State code"
     },
     "program_code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "program_type": {
      "type": "string",
      "description": "Kind",
      "enum": [
       "disability",
       "family_leave",
       "paid_leave",
       "long_term_care",
       "unemployment",
       "other"
      ]
     },
     "employee_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Employee rate"
     },
     "employer_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Employer rate"
     },
     "wage_base": {
      "type": "string",
      "format": "decimal",
      "description": "Annual wage base"
     },
     "employee_max_weekly": {
      "type": "string",
      "format": "decimal",
      "description": "Employee maximum a week"
     },
     "weekly_wage_cap": {
      "type": "string",
      "format": "decimal",
      "description": "Weekly wage ceiling"
     },
     "wage_basis": {
      "type": "string",
      "description": "Charged on",
      "enum": [
       "fica_wages",
       "state_wages",
       "gross"
      ]
     },
     "box14_label": {
      "type": "string",
      "description": "W-2 box 14 label"
     },
     "source_note": {
      "type": "string",
      "description": "Source"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/state-payroll-programs": {
   "get": {
    "summary": "list state-payroll-programs",
    "operationId": "list_state_payroll_programs_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create state-payroll-programs",
    "operationId": "create_state_payroll_programs_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/state-payroll-programs/{id}": {
   "get": {
    "summary": "get state-payroll-programs",
    "operationId": "get_state_payroll_programs_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change state-payroll-programs",
    "operationId": "change_state_payroll_programs_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete state-payroll-programs",
    "operationId": "delete_state_payroll_programs_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/state-payroll-programs/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_state_payroll_programs_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"
     }
    }
   }
  }
 }
}