# 홈택스 수집 요청

## 1. RequestJob - 수집 요청

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

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

```java
String requestJob(String CorpNum, QueryType QueryType, String SDate, String EDate, String UserID) throws PopbillException
```

### 요청

**Parameters**

- CorpNum `type: String` `length: 10` `required: Y` `description: 팝빌회원 사업자번호 ('-' 제외)`
- QueryType `type: QueryType` `length: -` `required: Y` `description: 현금영수증 유형 (택 1)`
  - `SELL`: 매출
  - `BUY`: 매입
- SDate `type: String` `length: 8` `required: Y` `description: 검색 시작일자`
  - 형식 : yyyyMMdd
- EDate `type: String` `length: 8` `required: Y` `description: 검색 종료일자`
  - 형식 : yyyyMMdd
- UserID `type: String` `length: 50` `required: N` `description: 팝빌회원 아이디`

### 응답

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

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: String` `length: -` `description: API 처리 실패에 대한 오류메시지`

## 2. GetJobState - 수집 상태 확인

[\[RequestJob – 수집 요청\]](https://developers.popbill.com/reference/htcashbill/java/api/job#RequestJob) API를 호출하고 반환 받은 작업아이디(JobID)를 이용하여 수집 상태를 확인합니다.

- 수집상태(jobState) = 3(완료) 이면서, 수집 결과코드(errorCode) = 1(수집성공)인 경우 [\[Search - 수집 내역 확인\]](https://developers.popbill.com/reference/htcashbill/java/api/search#Search) 이 가능합니다.

```java
HTCashbillJobState getJobState(String CorpNum, String JobID, String UserID) throws PopbillException
```

### 요청

**Parameters**

- CorpNum `type: String` `length: 10` `required: Y` `description: 팝빌회원 사업자번호 ('-' 제외)`
- JobID `type: String` `length: 18` `required: Y` `description: 팝빌에서 할당한 작업아이디`
  - [\[RequestJob - 수집 요청\]](https://developers.popbill.com/reference/htcashbill/java/api/job#RequestJob) API의 반환값
- UserID `type: String` `length: 50` `required: N` `description: 팝빌회원 아이디`

### 응답

**HTCashbillJobState**

- jobID `type: String` `length: 18` `description: 팝빌에서 할당한 작업아이디`
- jobState `type: String` `length: 1` `description: 수집상태`
  - `1`: 대기
  - `2`: 진행
  - `3`: 완료
- queryType `type: String` `length: -` `description: 현금영수증 유형`
  - `매출`
  - `매입`
- queryDateType `type: String` `length: 9` `description: 수집 일자 유형`
  - `TradeDT`: 거래일자
- queryStDate `type: String` `length: 8` `description: 시작일자`
  - 형식 : yyyyMMdd
- queryEnDate `type: String` `length: 8` `description: 종료일자`
  - 형식 : yyyyMMdd
- errorCode `type: long` `length: -` `description: 수집 결과코드`
  - 성공 : 1
  - 실패 : 음의 정수 8자리 숫자값
  - [\[참고\] 오류코드](https://developers.popbill.com/error-code "_blank")
- errorReason `type: String` `length: -` `description: 오류메시지`
  - 수집실패시 반환되는 사유
- jobStartDT `type: String` `length: 14` `description: 작업 시작일시`
  - 형식 : yyyyMMddHHmmss
- jobEndDT `type: String` `length: 14` `description: 작업 종료일시`
  - 형식 : yyyyMMddHHmmss
- collectCount `type: Integer` `length: -` `description: 수집건수`
- regDT `type: String` `length: 14` `description: 수집 요청일시`
  - 형식 : yyyyMMddHHmmss

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: String` `length: -` `description: API 처리 실패에 대한 오류메시지`

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

[\[RequestJob – 수집 요청\]](https://developers.popbill.com/reference/htcashbill/java/api/job#RequestJob) API를 호출하고 반환 받은 작업아이디(JobID) 목록의 수집 상태를 확인합니다.

```java
HTCashbillJobState[] listActiveJob(String CorpNum, String UserID) throws PopbillException
```

### 요청

**Parameters**

- CorpNum `type: String` `length: 10` `required: Y` `description: 팝빌회원 사업자번호 ('-' 제외)`
- UserID `type: String` `length: 50` `required: N` `description: 팝빌회원 아이디`

### 응답

**HTCashbillJobState\[ ]**

- jobID `type: String` `length: 18` `description: 팝빌에서 할당한 작업아이디`
- jobState `type: String` `length: 1` `description: 수집상태`
  - `1`: 대기
  - `2`: 진행
  - `3`: 완료
- queryType `type: String` `length: -` `description: 현금영수증 유형`
  - `매출`
  - `매입`
- queryDateType `type: String` `length: 9` `description: 수집 일자 유형`
  - `TradeDT`: 거래일자
- queryStDate `type: String` `length: 8` `description: 시작일자`
  - 형식 : yyyyMMdd
- queryEnDate `type: String` `length: 8` `description: 종료일자`
  - 형식 : yyyyMMdd
- errorCode `type: long` `length: -` `description: 수집 결과코드`
  - 성공 : 1
  - 실패 : 음의 정수 8자리 숫자값
  - [\[참고\] 오류코드](https://developers.popbill.com/error-code "_blank")
- errorReason `type: String` `length: -` `description: 오류메시지`
  - 수집실패시 반환되는 사유
- jobStartDT `type: String` `length: 14` `description: 작업 시작일시`
  - 형식 : yyyyMMddHHmmss
- jobEndDT `type: String` `length: 14` `description: 작업 종료일시`
  - 형식 : yyyyMMddHHmmss
- collectCount `type: Integer` `length: -` `description: 수집건수`
- regDT `type: String` `length: 14` `description: 수집 요청일시`
  - 형식 : yyyyMMddHHmmss

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: String` `length: -` `description: API 처리 실패에 대한 오류메시지`