홈택스 수집 요청
1. RequestJob - 수집 요청
섹션 제목: “1. RequestJob - 수집 요청”홈택스에 신고된 전자세금계산서 매입/매출 내역 수집을 팝빌에 요청합니다.
- 최대 3개월 단위로 수집 요청이 가능하며, 수집 기한의 제한은 없습니다.
- API를 호출하고 반환 받은 작업아이디(JobID)는 수집을 요청한 시점으로부터 1시간 동안만 유효합니다.
string RequestJob(string CorpNum, KeyType tiType, string DType, string SDate, string EDate, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | tiType | KeyType | - | Y | 전자세금계산서 유형 (택 1)
|
| 3 | DType | string | 1 | Y | 검색일자 유형 (택 1)
|
| 4 | SDate | string | 8 | Y | 검색 시작일자 형식 : yyyyMMdd |
| 5 | EDate | string | 8 | Y | 검색 종료일자 형식 : yyyyMMdd |
| 6 | UserID | string | 50 | N | 팝빌회원 아이디 |
string - 요청에 대한 작업아이디(JobID)
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
2. GetJobState - 수집 상태 확인
섹션 제목: “2. GetJobState - 수집 상태 확인”[RequestJob - 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID)를 이용하여 수집 상태를 확인합니다.
- 수집상태(jobState) = 3(완료) 이면서, 수집 결과코드(errorCode) = 1(수집성공)인 경우 [Search - 수집 내역 확인] 이 가능합니다.
HTTaxinvoiceJobState GetJobState(string CorpNum, string JobID, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | JobID | string | 18 | Y | 팝빌에서 할당한 작업아이디 [RequestJob - 수집 요청] API의 반환값 |
| 3 | UserID | string | 50 | N | 팝빌회원 아이디 |
HTTaxinvoiceJobState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | jobID | string | 18 | 팝빌에서 할당한 작업아이디 |
| 2 | jobState | int? | - | 수집상태
|
| 3 | queryType | string | 2 | 전자세금계산서 유형
|
| 4 | queryDateType | string | 9 | 일자유형
|
| 5 | queryStDate | string | 8 | 시작일자 형식 : yyyyMMdd |
| 6 | queryEnDate | string | 8 | 종료일자 형식 : yyyyMMdd |
| 7 | errorCode | long? | - | |
| 8 | errorReason | string | - | 오류메시지 수집실패시 반환되는 사유 |
| 9 | jobStartDT | string | 14 | 작업 시작일시 형식 : yyyyMMddHHmmss |
| 10 | jobEndDT | string | 14 | 작업 종료일시 형식 : yyyyMMddHHmmss |
| 11 | collectCount | long | - | 수집건수 |
| 12 | regDT | string | 14 | 수집 요청일시 형식 : yyyyMMddHHmmss |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
3. ListActiveJob - 수집 상태 목록 확인
섹션 제목: “3. ListActiveJob - 수집 상태 목록 확인”[RequestJob – 수집 요청] API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.
List<HTTaxinvoiceJobState> ListActiveJob(string CorpNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | string | 50 | N | 팝빌회원 아이디 |
List<HTTaxinvoiceJobState>
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | jobID | string | 18 | 팝빌에서 할당한 작업아이디 |
| 2 | jobState | int? | - | 수집상태
|
| 3 | queryType | string | 2 | 전자세금계산서 유형
|
| 4 | queryDateType | string | 9 | 일자유형
|
| 5 | queryStDate | string | 8 | 시작일자 형식 : yyyyMMdd |
| 6 | queryEnDate | string | 8 | 종료일자 형식 : yyyyMMdd |
| 7 | errorCode | long? | - | |
| 8 | errorReason | string | - | 오류메시지 수집실패시 반환되는 사유 |
| 9 | jobStartDT | string | 14 | 작업 시작일시 형식 : yyyyMMddHHmmss |
| 10 | jobEndDT | string | 14 | 작업 종료일시 형식 : yyyyMMddHHmmss |
| 11 | collectCount | long | - | 수집건수 |
| 12 | regDT | string | 14 | 수집 요청일시 형식 : yyyyMMddHHmmss |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |