1. 내역 수집
1.1. RequestJob - 수집 요청
홈택스에 신고된 현금영수증 매입/매출 내역 수집을 팝빌에 요청합니다.
- 최대 3개월 단위로 수집 요청이 가능하며, 수집기한의 제한은 없습니다.
- API를 호출하고 반환 받은 작업아이디(JobID)는 수집을 요청한 시점으로부터 1시간 동안만 유효합니다.
def requestJob(CorpNum, Type, SDate, EDate, UserID=None):Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| Type | str | 4 | Y |
현금영수증 유형 (택 1)
SELL매출
BUY매입
|
|
| SDate | str | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
| EDate | str | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
| UserID | str | 50 | N | 팝빌회원 아이디 |
Return
str - 요청에 대한 작업아이디(JobID)
Throws
1.2. GetJobState - 수집 상태 확인
[RequestJob – 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID)를 이용하여 수집 상태를 확인합니다.
- 수집상태(jobState) = 3(완료) 이면서, 수집 결과코드(errorCode) = 1(수집성공)인 경우 [Search - 수집 내역 확인] 이 가능합니다.
def getJobState(CorpNum, JobID, UserID=None):Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| JobID | str | 18 | Y |
작업아이디
[RequestJob - 수집 요청] API의 반환값
|
|
| UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.3. ListActiveJob - 수집 상태 목록 확인
[RequestJob – 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.def listActiveJob(CorpNum, UserID=None):Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | str | 50 | N | 팝빌회원 아이디 |