> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/hris-configuration-resource.md).

# Hris Configuration Resource

## GET /api/v1/company/hris

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"BambooHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}},"MergeHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"PersonioHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"}}}]},"WoltersKluwerHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"},"redirectUrl":{"type":"string"}}}]}}},"paths":{"/api/v1/company/hris":{"get":{"tags":["hris-configuration-resource"],"operationId":"getCurrentHRISConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BambooHRISConfigurationDTO"},{"$ref":"#/components/schemas/MergeHRISConfigurationDTO"},{"$ref":"#/components/schemas/PersonioHRISConfigurationDTO"},{"$ref":"#/components/schemas/WoltersKluwerHRISConfigurationDTO"}]}}}}}}}}}
```

## POST /api/v1/company/hris

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"BambooHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}},"MergeHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"PersonioHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"}}}]},"WoltersKluwerHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"},"redirectUrl":{"type":"string"}}}]}}},"paths":{"/api/v1/company/hris":{"post":{"tags":["hris-configuration-resource"],"operationId":"setCurrentHRISConfiguration","requestBody":{"content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BambooHRISConfigurationDTO"},{"$ref":"#/components/schemas/MergeHRISConfigurationDTO"},{"$ref":"#/components/schemas/PersonioHRISConfigurationDTO"},{"$ref":"#/components/schemas/WoltersKluwerHRISConfigurationDTO"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BambooHRISConfigurationDTO"},{"$ref":"#/components/schemas/MergeHRISConfigurationDTO"},{"$ref":"#/components/schemas/PersonioHRISConfigurationDTO"},{"$ref":"#/components/schemas/WoltersKluwerHRISConfigurationDTO"}]}}}}}}}}}
```

## DELETE /api/v1/company/hris

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}}},"paths":{"/api/v1/company/hris":{"delete":{"tags":["hris-configuration-resource"],"operationId":"deleteCurrentHRISConfiguration","responses":{"200":{"description":"OK"}}}}}}
```
