홈택스 수집 요청

1. RequestJob - 수집 요청

홈택스에 신고된 현금영수증 매입/매출 내역 수집을 팝빌에 요청합니다.

• 최대 3개월 단위로 수집 요청이 가능하며, 수집기한의 제한은 없습니다.
• API를 호출하고 반환 받은 작업아이디(JobID)는 수집을 요청한 시점으로부터 1시간 동안만 유효합니다.

def requestJob(CorpNum, Type, SDate, EDate, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	Type	str	4	Y	현금영수증 유형 (택 1) SELL 매출 BUY 매입
3	SDate	str	8	Y	검색 시작일자 → 형식 : yyyyMMdd
4	EDate	str	8	Y	검색 종료일자 → 형식 : yyyyMMdd
5	UserID	str	50	N	팝빌회원 아이디

응답

str - 요청에 대한 작업아이디(JobID)

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

2. GetJobState - 수집 상태 확인

[RequestJob – 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID)를 이용하여 수집 상태를 확인합니다.

• 수집상태(jobState) = 3(완료) 이면서, 수집 결과코드(errorCode) = 1(수집성공)인 경우 [Search - 수집 내역 확인] 이 가능합니다.

def getJobState(CorpNum, JobID, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	JobID	str	18	Y	팝빌에서 할당한 작업아이디 → [RequestJob - 수집 요청] API의 반환값
3	UserID	str	50	N	팝빌회원 아이디

응답

HTCashbillJobState

순번	변수명	타입	길이	설명
1	jobID	str	18	팝빌에서 할당한 작업아이디
2	jobState	str	1	수집상태 1 대기 2 진행 3 완료
3	Type	str	-	현금영수증 유형 매출 매입
4	queryDateType	str	9	수집 일자 유형 TradeDT 거래일자
5	queryStDate	str	8	시작일자 → 형식 : yyyyMMdd
6	queryEnDate	str	8	종료일자 → 형식 : yyyyMMdd
7	errorCode	int	-	수집 결과코드 → 성공 : 1 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
8	errorReason	str	-	오류메시지 → 수집실패시 반환되는 사유
9	jobStartDT	str	14	작업 시작일시 → 형식 : yyyyMMddHHmmss
10	jobEndDT	str	14	작업 종료일시 → 형식 : yyyyMMddHHmmss
11	collectCount	int	-	수집건수
12	regDT	str	14	수집 요청일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

3. ListActiveJob - 수집 상태 목록 확인

[RequestJob - 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.

def listActiveJob(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	str	50	N	팝빌회원 아이디

응답

list[HTCashbillJobState]

순번	변수명	타입	길이	설명
1	jobID	str	18	팝빌에서 할당한 작업아이디
2	jobState	str	1	수집상태 1 대기 2 진행 3 완료
3	Type	str	-	현금영수증 유형 매출 매입
4	queryDateType	str	9	수집 일자 유형 TradeDT 거래일자
5	queryStDate	str	8	시작일자 → 형식 : yyyyMMdd
6	queryEnDate	str	8	종료일자 → 형식 : yyyyMMdd
7	errorCode	int	-	수집 결과코드 → 성공 : 1 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
8	errorReason	str	-	오류메시지 → 수집실패시 반환되는 사유
9	jobStartDT	str	14	작업 시작일시 → 형식 : yyyyMMddHHmmss
10	jobEndDT	str	14	작업 종료일시 → 형식 : yyyyMMddHHmmss
11	collectCount	int	-	수집건수
12	regDT	str	14	수집 요청일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지