GET/business-support/attendance/timecards

출퇴근 정보 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

businessSupport.attendance
businessSupport.attendance.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/business-support/attendance/timecards

Query Parameters

ParameterTypeDescription
userId string 

사용자 ID

 
fromDate string 

시작 일자 (YYYY-MM-DD)


required 
toDate string 

종료 일자 (YYYY-MM-DD)


required 
count integer 

목록 조회 개수


minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

다음 목록 조회 시 사용하는 값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

출퇴근 목록

PropertyTypeDescription
timecards array (Timecard) 
 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

Timecard

PropertyTypeDescription
timecardId string 

사용자 출퇴근의 타임카드 ID

 
userId string 

사용자 ID


example : be1047ee-0eda-45d3-1867-03a9c2c4e402 
userName string 

사용자 이름

 
baseDate string 

출퇴근 기준일자

  • 형식: YYYY-MM-DD
 
clockInTime string 

출근 시간

  • 형식: YYYY-MM-DDThh:mm:ssTZD
 
clockOutTime string 

퇴근 시간

  • 형식: YYYY-MM-DDThh:mm:ssTZD
 
clockInLocation string 

출근 위치

 
clockOutLocation string 

퇴근 위치

 
breakTimeTotalMinutes integer 

휴게 시간 (분)


minimum : 0 
breakTimes array (object) 

휴게 시간 리스트

 
offSiteWorkTotalMinutes integer 

외근 시간 (분)


minimum : 0 
offSiteWorkTimes array (object) 

외근 시간 리스트

 
absenceTotalMinutes integer 

부재 시간 (분)


minimum : 0 
absenceTimes array (object) 

부재 시간 리스트

 
lateType string 

지각 구분

  • LATE: 지각
  • NOT_LATE: 지각 아님
  • UNABLE_TO_CHECK: 지각 체크 불가

Allowed values : LATE, NOT_LATE, UNABLE_TO_CHECK 
earlyType string 

조퇴 구분

  • EARLY: 조퇴
  • NOT_EARLY: 조퇴 아님
  • UNABLE_TO_CHECK: 조퇴 체크 불가

Allowed values : EARLY, NOT_EARLY, UNABLE_TO_CHECK 
obligatoryType string 

의무 근로 준수 상태

  • OBLIGATORY: 의무 근로 준수
  • NOT_OBLIGATORY: 의무 근로 미준수
  • UNABLE_TO_CHECK: 의무 근로 체크 불가

Allowed values : OBLIGATORY, NOT_OBLIGATORY, UNABLE_TO_CHECK 
actualWorkMinutes integer 

실 근로 시간 (분)


minimum : 0 
regularWorkMinutes integer 

일반 근로 시간 (분)


minimum : 0 
extendedWorkMinutes integer 

연장 근로 시간 (분)


minimum : 0 
nightWorkMinutes integer 

야간 근로 시간 (분)


minimum : 0 
holidayRegularWorkMinutes integer 

휴일 일반 근로 시간 (분)


minimum : 0 
holidayExtendedWorkMinutes integer 

휴일 연장 근로 시간 (분)


minimum : 0 
holidayNightWorkMinutes integer 

휴일 야간 근로 시간 (분)


minimum : 0 
totalWorkMinutes integer 

총 근로 시간 (분)


minimum : 0 

object

PropertyTypeDescription
startTime string 

시작 시간

  • 형식: YYYY-MM-DDThh:mm:ssTZD
 
endTime string 

종료 시간

  • 형식: YYYY-MM-DDThh:mm:ssTZD
 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

Response Example

Example 1

1{2  "timecards": [3    {4      "timecardId": "96b02530-82de-41c8-8223-3055c74e705e_a6694d6128ed806e5ff490dad42e3fad",5      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "userName": "홍길동",7      "baseDate": "2024-06-03",8      "clockInTime": "2024-06-03T09:00:00+09:00",9      "clockOutTime": "2024-06-03T18:00:00+09:00",10      "clockInLocation": "서울오피스",11      "clockOutLocation": "서울오피스",12      "breakTimeTotalMinutes": 60,13      "breakTimes": [14        {15          "startTime": "2024-06-03T12:00:00+09:00",16          "endTime": "2024-06-03T13:00:00+09:00"17        }18      ],19      "offSiteWorkTotalMinutes": 0,20      "offSiteWorkTimes": [],21      "absenceTotalMinutes": 0,22      "absenceTimes": [],23      "lateType": "NOT_LATE",24      "earlyType": "NOT_EARLY",25      "obligatoryType": "UNABLE_TO_CHECK",26      "actualWorkMinutes": 480,27      "regularWorkMinutes": 480,28      "extendedWorkMinutes": 0,29      "nightWorkMinutes": 0,30      "holidayRegularWorkMinutes": 0,31      "holidayExtendedWorkMinutes": 0,32      "holidayNightWorkMinutes": 0,33      "totalWorkMinutes": 48034    }35  ],36  "responseMetaData": {37    "nextCursor": "H4sIAAAAAAAAAKtWykutKHEuLSrOL1KyUjI0UKoFAOWyZdITAAAA"38  }39}