수집 내역 확인

1. Search - 수집 내역 확인

GET https://popbill-test.linkhub.co.kr/HomeTax/Cashbill/{jobID}

홈택스에서 수집된 현금영수증 매입/매출 내역을 확인합니다.
18개 항목으로 구성된 내역 확인이 가능합니다.

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`jobID`	string	18	Y	팝빌에서 할당한 작업아이디 [RequestJob - 수집 요청] API의 반환값

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`TradeUsage`	string	-	N	현금영수증 거래구분 (다중 선택 가능) `P` 소득공제용 `C` 지출증빙용 다중 선택시 콤마(',')로 구분. 예) P,C 기본값 : 전체조회
2	`TradeType`	string	-	N	현금영수증 문서형태 (다중 선택 가능) `N` 승인 현금영수증 `C` 취소 현금영수증 다중 선택시 콤마(',')로 구분. 예) N,C 기본값 : 전체조회
3	`Page`	number	-	N	목록 페이지번호 기본값 : 1
4	`PerPage`	number	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
5	`Order`	string	1	N	목록 정렬 방향 `D` 내림차순 : 기본값 `A` 오름차순 API를 호출하고 반환 받은 거래일시(tradeDT) 기준

요청 예시

curl --request GET \
  --url 'https://{domain}/HomeTax/Cashbill/{jobID}?TradeUsage={TradeUsage}&TradeType={TradeType}&Page={Page}&PerPage={PerPage}&Order={Order}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번 변수명 타입 길이 설명

code

number

API 처리에 대한 응답코드

1 성공

total

number

총 검색결과 건수

perPage

number

페이지당 목록 건수

pageNum

number

페이지 번호

pageCount

number

페이지 개수

array

현금영수증 정보

최대 : 1,000건

list

순번	변수명	타입	길이	설명
1	`ntsconfirmNum`	string	24	국세청승인번호
2	`tradeDate`	string	8	거래일자 형식 : yyyyMMdd
3	`tradeDT`	string	14	거래일시 형식 : yyyyMMddHHmmss
4	`tradeType`	string	4	문서형태 `승인거래` `취소거래`
5	`tradeUsage`	string	5	거래구분 `소득공제용` `지출증빙용`
6	`totalAmount`	string	9	거래금액
7	`supplyCost`	string	9	공급가액
8	`tax`	string	9	부가세
9	`serviceFee`	string	9	봉사료
10	`invoiceType`	string	-	현금영수증 유형 `매출` `매입`
11	`franchiseCorpNum`	string	10	가맹점(발행자) 사업자번호 {invoiceType}="매입" 경우 반환
12	`franchiseCorpName`	string	200	가맹점(발행자) 상호 {invoiceType}="매입" 경우 반환
13	`franchiseCorpType`	number	1	가맹점(발행자) 사업자유형 `1` 일반과세자 `2` 간이과세자 `3` 과세특례자 `4` 면세사업자 `5` 법인사업자 {invoiceType}="매입" 경우 반환
14	`identityNum`	string	4	식별번호 식별번호의 마지막 4자리 숫자만 반환
15	`identityNumType`	number	1	식별번호 유형 `1` 주민등록번호 `2` 사업자번호 `3` 휴대폰번호 `4` 카드번호
16	`customerName`	string	70	구매자(고객) 성명
17	`cardOwnerName`	string	70	카드소유자명
18	`deductionType`	number	1	공제유형 `1` 공제 `3` 불공제

응답 예시

{
    "code": 1,
    "total": 1,
    "perPage": 500,
    "pageNum": 1,
    "pageCount": 1,
    "list": [
        {
            "invoiceType": "매출",
            "ntsconfirmNum": "Z55904818",
            "tradeDate": "20250507",
            "tradeDT": "20250507102940",
            "tradeUsage": "지출증빙용",
            "tradeType": "취소거래",
            "supplyCost": "910",
            "tax": "90",
            "serviceFee": "0",
            "totalAmount": "1000",
            "franchiseCorpNum": "6798700433",
            "franchiseCorpType": 0,
            "identityNumType": 1,
            "identityNum": "3713",
            "customerName": "정요한",
            "deductionType": 0
        }
    ],
    "message": "확인완료"
}

2. Summary - 수집 내역 합계

GET https://popbill-test.linkhub.co.kr/HomeTax/Cashbill/{jobID}/Summary

홈택스에서 수집된 현금영수증 매입/매출 내역의 합계정보를 제공합니다.
※ 합계정보 - 수집 건수, 공급가액 합계, 부가세 합계, 봉사료 합계, 거래금액 합계 (공급가액 합계+부가세 합계+봉사료 합계)

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`jobID`	string	18	Y	팝빌에서 할당한 작업아이디 [RequestJob - 수집 요청] API의 반환값

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`TradeUsage`	string	-	N	현금영수증 거래구분 (다중 선택 가능) `P` 소득공제용 `C` 지출증빙용 다중 선택시 콤마(',')로 구분. 예) P,C 기본값 : 전체조회
2	`TradeType`	string	-	N	현금영수증 문서형태 (다중 선택 가능) `N` 승인 현금영수증 `C` 취소 현금영수증 다중 선택시 콤마(',')로 구분. 예) N,C 기본값 : 전체조회

요청 예시

curl --request GET \
  --url 'https://{domain}/HomeTax/Cashbill/{jobID}/Summary?TradeUsage={TradeUsage}&TradeType={TradeType}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`count`	number	-	수집 건수
2	`supplyCostTotal`	number	18	공급가액 합계
3	`taxTotal`	number	18	세액 합계
4	`serviceFeeTotal`	number	18	봉사료 합계
5	`amountTotal`	number	18	거래금액 합계 (공급가액 합계+부가세 합계+봉사료 합계)

응답 예시

{
    "count": 2,
    "supplyCostTotal": 1820,
    "taxTotal": 180,
    "serviceFeeTotal": 0,
    "amountTotal": 2000
}