> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/holiday-management.md).

# Holiday Management

## Register/Modify/Delete Holiday

> \## Function Description\
> \* Registers, modifies, and deletes a holiday.\
> \---\
> \## Detailed Description\
> \* Modifies the public holiday type, holiday menu, and usage status for a holiday.\
> \* Deletes the holiday list.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestStHoliInfo":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}}}},"StHoliInfo":{"type":"object","properties":{"holiDt":{"type":"string","description":"Holiday Date"},"holiJobGbCd":{"type":"string","description":"Holiday Task Type Code (CM001) 01: General Holiday, 02: Store Holiday, 03: Distribution Center (Courier Delivery), 04: Customer Center"},"holiGbCd":{"type":"string","description":"Public Holiday Type Code (CM002) 01: National Holiday, 02: Holiday, 03: Lunar New Year, 04: Chuseok, 05: Other"},"holiMemo":{"type":"string","description":"Holiday Memo"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/holidayMgmt/saveHolidayList":{"post":{"tags":["Holiday Management"],"summary":"Register/Modify/Delete Holiday","description":"## Function Description\n* Registers, modifies, and deletes a holiday.\n---\n## Detailed Description\n* Modifies the public holiday type, holiday menu, and usage status for a holiday.\n* Deletes the holiday list.\n","operationId":"saveHolidayList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestStHoliInfo"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Bulk Register Holidays

> \## Function Description\
> \* Bulk registers holidays.\
> \---\
> \## Detailed Description\
> \* Bulk registers holiday information from a file uploaded as Excel or CSV.\
> \* Returns the dates that could not be registered due to duplicate holidays.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestStHoliInfo":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/StHoliInfo"}}}},"StHoliInfo":{"type":"object","properties":{"holiDt":{"type":"string","description":"Holiday Date"},"holiJobGbCd":{"type":"string","description":"Holiday Task Type Code (CM001) 01: General Holiday, 02: Store Holiday, 03: Distribution Center (Courier Delivery), 04: Customer Center"},"holiGbCd":{"type":"string","description":"Public Holiday Type Code (CM002) 01: National Holiday, 02: Holiday, 03: Lunar New Year, 04: Chuseok, 05: Other"},"holiMemo":{"type":"string","description":"Holiday Memo"},"useYn":{"type":"string","description":"Usage Status"}}},"RealGridListResponseStHoliBatchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/StHoliBatchResponse"}}}},"StHoliBatchResponse":{"type":"object","description":"User Detail Information Response DTO","properties":{"holiDt":{"type":"string","description":"Holiday Date"},"holiJobGbCd":{"type":"string","description":"Holiday Task Type Code (CM001) 01: General Holiday, 02: Store Holiday, 03: Distribution Center (Courier Delivery), 04: Customer Center"},"holiGbCd":{"type":"string","description":"Public Holiday Type Code (CM002) 01: National Holiday, 02: Holiday, 03: Lunar New Year, 04: Chuseok, 05: Other"},"holiMemo":{"type":"string","description":"Holiday Memo"},"useYn":{"type":"string","description":"Usage Status"},"errMsg":{"type":"string","description":"User Detail Information"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/holidayMgmt/registHolidayExcelList":{"post":{"tags":["Holiday Management"],"summary":"Bulk Register Holidays","description":"## Function Description\n* Bulk registers holidays.\n---\n## Detailed Description\n* Bulk registers holiday information from a file uploaded as Excel or CSV.\n* Returns the dates that could not be registered due to duplicate holidays.\n","operationId":"registHolidayExcelList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestStHoliInfo"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseStHoliBatchResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Holiday Management List

> \## Function Description\
> \* Retrieves the holiday list matching the holiday date, business type, and holiday type passed from the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the holiday list matching the holiday date, business type, and holiday type passed from the screen.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"HolidayMgmtRequest":{"type":"object","properties":{"holiDtS":{"type":"string","minLength":1},"holiDtE":{"type":"string","minLength":1},"holiJobGbCd":{"type":"string","minLength":1},"holiGbCd":{"type":"string","minLength":1},"useYn":{"type":"string","minLength":1},"holiMemo":{"type":"string"},"dateSelect":{"type":"string","minLength":1}},"required":["dateSelect","holiDtE","holiDtS","holiGbCd","holiJobGbCd","useYn"]},"RealGridListResponseHolidayMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/HolidayMgmtResponse"}}}},"HolidayMgmtResponse":{"type":"object","description":"Holiday Management Retrieval Response","properties":{"holiDt":{"type":"string","description":"Holiday Date"},"holiJobGbCd":{"type":"string","description":"Business Type (CM001)"},"holiGbCd":{"type":"string","description":"Business Type (CM002)"},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"]},"holiMemo":{"type":"string","description":"Holiday Description"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/holidayMgmt/getHolidayList":{"get":{"tags":["Holiday Management"],"summary":"Retrieve Holiday Management List","description":"## Function Description\n* Retrieves the holiday list matching the holiday date, business type, and holiday type passed from the screen.\n---\n## Detailed Description\n* Retrieves the holiday list matching the holiday date, business type, and holiday type passed from the screen.\n","operationId":"getHolidayList","parameters":[{"name":"holidayMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/HolidayMgmtRequest"}},{"name":"holiDtS","in":"query","description":"Start Date","required":true,"schema":{"type":"string"}},{"name":"holiDtE","in":"query","description":"End Date","required":true,"schema":{"type":"string"}},{"name":"holiJobGbCd","in":"query","description":"Holiday Business Classification Code (CM001)","schema":{"type":"string"}},{"name":"holiGbCd","in":"query","description":"Holiday Type Code (CM002)","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseHolidayMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
