수집 내역 확인

1. Search - 수집 내역 확인

홈택스에서 수집된 전자세금계산서 매입/매출 내역을 확인합니다.

• 38개 항목으로 구성된 내역 확인이 가능합니다.

Function Search(CorpNum As String, jobID As String, tiType As Collection, taxType As Collection, purposeType As Collection, taxRegIDType As String, taxRegID As String, taxRegIDYN As String, page As Integer, perPage As Integer, order As String, Optional UserID As String = "", Optional SearchString As String = "") As PBHTTaxinvoiceSearch

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

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	jobID	String	18	Y	팝빌에서 할당한 작업아이디 → [RequestJob - 수집 요청] API의 반환값
3	tiType	Collection	-	N	세금계산서 문서형태 (다중 선택 가능) N 세금계산서 M 수정세금계산서 ※ 기본값 : 전체조회
4	taxType	Collection	-	N	과세형태 (다중 선택 가능) T 과세 N 면세 Z 영세 ※ 기본값 : 전체조회
5	purposeType	Collection	-	N	영수/청구 (다중 선택 가능) R 영수 C 청구 N 없음 ※ 기본값 : 전체조회
6	taxRegIDType	String	-	N	종사업장번호의 주체 S 공급자 B 공급받는자 T 수탁자 ※ 기본값 : 전체조회
7	taxRegID	String	-	N	종사업장번호 → 다수건 검색시 콤마(',')로 구분. 예) 1234,1000 ※ 기본값 : 전체조회
8	taxRegIDYN	String	1	N	종사업장번호 유무 0 없음 1 있음 ※ 기본값 : 전체조회
9	page	Integer	-	N	목록 페이지번호 ※ 기본값 : 1
10	perPage	Integer	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
11	order	String	1	N	목록 정렬 방향 D 내림차순 : 기본값 A 오름차순 → [RequestJob - 수집 요청] API의 매개변수 {DType} 기준
12	UserID	String	50	N	팝빌회원 아이디
13	SearchString	String	13	N	조회 검색어 ('-' 제외) → 상호명 조회시 거래처상호 입력 사업자 조회시 사업자번호 입력 개인 조회시 주민등록번호 입력 외국인 조회시 "9999999999999" 입력 ※ 기본값 : 전체조회

응답

PBHTTaxinvoiceSearch

순번	변수명	타입	길이	설명
1	code	Long	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	total	Integer	-	총 검색결과 건수
4	perPage	Integer	-	페이지당 목록 건수
5	pageNum	Integer	-	페이지 번호
6	pageCount	Integer	-	페이지 개수
7	list	PBHTTaxinvoiceAbbr[ ]	-	세금계산서 요약정보 → 최대 : 1,000건
PBHTTaxinvoiceAbbr[ ] 순번 변수명 타입 길이 설명 1 ntsconfirmNum String 24 전자세금계산서 국세청승인번호 2 writeDate String 8 작성일자 → 형식 : yyyyMMdd 3 issueDate String 8 발행일자 → 형식 : yyyyMMdd 4 sendDate String 8 전송일자 → 형식 : yyyyMMdd 5 taxType String 2 과세형태 과세 영세 면세 6 purposeType String 2 영수/청구 영수 청구 없음 7 supplyCostTotal String 18 공급가액 합계 8 taxTotal String 18 세액 합계 9 totalAmount String 18 합계금액 10 remark1 String 450 비고 → 전자세금계산서 비고1/2/3 값의 합 11 invoiceType String 2 전자세금계산서 유형 매입 매출 12 modifyYN Boolean - 수정 전자세금계산서 여부 True 수정세금계산서 False 일반세금계산서 13 orgNTSConfirmNum String 24 당초 국세청승인번호 14 purchaseDate String 8 품목1의 거래일자 → 형식 : yyyyMMdd 15 itemName String 100 품목1의 품명 16 spec String 60 품목1의 규격 17 qty String 12 품목1의 수량 → 소수점 아래 2번째 자리까지 반환 가능 마이너스 금액 반환 가능 18 unitCost String 18 품목1의 단가 → 소수점 아래 2번째 자리까지 반환 가능 마이너스 금액 반환 가능 19 supplyCost String 18 품목1의 공급가액 → 마이너스 금액 반환 가능 20 tax String 18 품목1의 세액 → 마이너스 금액 반환 가능 21 remark String 100 품목1의 비고 22 invoicerCorpNum String 10 공급자 사업자번호 23 invoicerTaxRegID String 4 공급자 종사업장 식별번호 24 invoicerCorpName String 200 공급자 상호 25 invoicerCEOName String 100 공급자 대표자 성명 26 invoicerEmail String 100 공급자 담당자 메일 27 invoiceeCorpNum String 13 공급받는자 등록번호 → {invoiceeType}="사업자" 경우 사업자번호 {invoiceeType}="개인" 경우 주민등록번호 {invoiceeType}="외국인" 경우 "9999999999999" 28 invoiceeType String 3 공급받는자 유형 사업자 개인 외국인 29 invoiceeTaxRegID String 4 공급받는자 종사업장 식별번호 30 invoiceeCorpName String 200 공급받는자 상호 31 invoiceeCEOName String 100 공급받는자 대표자 성명 32 invoiceeEmail1 String 100 공급받는자 담당자 메일 33 invoiceeEmail2 String 70 공급받는자 부) 담당자 메일 34 trusteeCorpNum String 10 수탁자 사업자번호 35 trusteeTaxRegID String 4 수탁자 종사업장 식별번호 36 trusteeCorpName String 200 수탁자 상호 37 trusteeCEOName String 100 수탁자 대표자 성명 38 trusteeEmail String 100 수탁자 담당자 메일

예외

Err

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

2. Summary - 수집 내역 합계

홈택스에서 수집된 전자세금계산서 매입/매출 내역의 합계정보를 제공합니다.
※ 합계정보 - 수집 건수, 공급가액 합계, 세액 합계, 총계 (공급가액 합계+세액 합계)

Function Summary(CorpNum As String, jobID As String, tiType As Collection, taxType As Collection, purposeType As Collection, taxRegIDType As String, taxRegID As String, taxRegIDYN As String, Optional UserID As String = "", Optional SearchString As String = "") As PBHTTaxinvoiceSummary

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	jobID	String	18	Y	팝빌에서 할당한 작업아이디 → [RequestJob - 수집 요청] API의 반환값
3	tiType	Collection	-	N	세금계산서 문서형태 (다중 선택 가능) N 세금계산서 M 수정세금계산서 ※ 기본값 : 전체조회
4	taxType	Collection	-	N	과세형태 (다중 선택 가능) T 과세 N 면세 Z 영세 ※ 기본값 : 전체조회
5	purposeType	Collection	-	N	영수/청구 (다중 선택 가능) R 영수 C 청구 N 없음 ※ 기본값 : 전체조회
6	taxRegIDType	String	-	N	종사업장번호의 주체 S 공급자 B 공급받는자 T 수탁자 ※ 기본값 : 전체조회
7	taxRegID	String	-	N	종사업장번호 → 다수건 검색시 콤마(',')로 구분. 예) 1234,1000 ※ 기본값 : 전체조회
8	taxRegIDYN	String	1	N	종사업장번호 유무 0 없음 1 있음 ※ 기본값 : 전체조회
9	UserID	String	50	N	팝빌회원 아이디
10	SearchString	String	13	N	조회 검색어 ('-' 제외) → 상호명 조회시 거래처상호 입력 사업자 조회시 사업자번호 입력 개인 조회시 주민등록번호 입력 외국인 조회시 "9999999999999" 입력 ※ 기본값 : 전체조회

응답

PBHTTaxinvoiceSummary

순번	변수명	타입	길이	설명
1	count	long	-	수집 건수
2	supplyCostTotal	long	18	공급가액 합계
3	taxTotal	long	18	세액 합계
4	amountTotal	long	18	총계 (공급가액 합계+세액 합계)

예외

Err

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

3. GetTaxinvoice - 수집 상세 확인

홈택스에서 수집된 전자세금계산서 1건의 상세정보를 제공합니다.

• 60개 항목과 99개 품목으로 구성된 정보 확인이 가능합니다.

Function GetTaxinvoice(CorpNum As String, ntsconfirmNum As String, Optional UserID As String = "") As PBHTTaxinvoice

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ntsconfirmNum	String	24	Y	전자세금계산서 국세청승인번호
3	UserID	String	50	N	팝빌회원 아이디

응답

PBHTTaxinvoice

순번	변수명	타입	길이	설명
1	writeDate	String	8	작성일자 → 형식 : yyyyMMdd
2	issueDT	String	14	발행일시 → 형식 : yyyyMMddHHmmss
3	invoiceType	String	3	전자세금계산서 종류 101 세금계산서 102 영세율 세금계산서 103 위수탁 세금계산서 104 수입 세금계산서 105 위수탁영세율 세금계산서 201 수정세금계산서 202 영세율 수정세금계산서 203 위수탁 수정세금계산서 204 수입 수정세금계산서 205 위수탁영세율 수정세금계산서 301 계산서 303 위수탁 계산서 304 수입 계산서 401 수정계산서 403 위수탁 수정계산서 404 수입 수정계산서
4	taxType	String	2	과세형태 과세 영세 면세
5	taxTotal	String	18	세액 합계
6	supplyCostTotal	String	18	공급가액 합계
7	totalAmount	String	18	합계금액
8	purposeType	String	2	영수/청구 영수 청구 없음
9	serialNum	String	30	일련번호
10	cash	String	18	현금
11	chkBill	String	18	수표
12	credit	String	18	외상
13	note	String	18	어음
14	remark1	String	150	비고1
15	remark2	String	150	비고2
16	remark3	String	150	비고3
17	ntsconfirmNum	String	24	국세청승인번호
18	invoicerCorpNum	String	10	공급자 사업자번호
19	invoicerMgtKey	String	24	공급자 문서번호
20	invoicerTaxRegID	String	4	공급자 종사업장 식별번호 → 종사업장 식별번호는 4자리 숫자로만 구성
21	invoicerCorpName	String	200	공급자 상호
22	invoicerCEOName	String	100	공급자 대표자 성명
23	invoicerAddr	String	300	공급자 주소
24	invoicerBizType	String	100	공급자 업태
25	invoicerBizClass	String	100	공급자 종목
26	invoicerContactName	String	100	공급자 담당자 성명
27	invoicerDeptName	String	100	공급자 담당자 부서명
28	invoicerTEL	String	20	공급자 담당자 연락처
29	invoicerEmail	String	100	공급자 담당자 메일
30	invoiceeCorpNum	String	13	공급받는자 등록번호 ('-' 제외) → {invoiceeType}="사업자" 경우 사업자번호 {invoiceeType}="개인" 경우 주민등록번호 {invoiceeType}="외국인" 경우 "9999999999999"
31	invoiceeType	String	3	공급받는자 유형 사업자 개인 외국인
32	invoiceeMgtKey	String	24	공급받는자 문서번호
33	invoiceeTaxRegID	String	4	공급받는자 종사업장 식별번호 → 종사업장 식별번호는 4자리 숫자로만 구성
34	invoiceeCorpName	String	200	공급받는자 상호
35	invoiceeCEOName	String	100	공급받는자 대표자 성명
36	invoiceeAddr	String	300	공급받는자 주소
37	invoiceeBizType	String	100	공급받는자 업태
38	invoiceeBizClass	String	100	공급받는자 종목
39	invoiceeContactName1	String	100	공급받는자 주) 담당자 성명
40	invoiceeDeptName1	String	100	공급받는자 주) 담당자 부서명
41	invoiceeTEL1	String	20	공급받는자 주) 담당자 연락처
42	invoiceeEmail1	String	100	공급받는자 주) 담당자 메일
43	invoiceeContactName2	String	100	공급받는자 부) 담당자 성명
44	invoiceeDeptName2	String	100	공급받는자 부) 담당자 부서명
45	invoiceeTEL2	String	20	공급받는자 부) 담당자 연락처
46	invoiceeEmail2	String	100	공급받는자 부) 담당자 메일
47	trusteeCorpNum	String	10	수탁자 사업자번호
48	trusteeMgtKey	String	24	수탁자 문서번호
49	trusteeTaxRegID	String	4	수탁자 종사업장 식별번호 → 종사업장 식별번호는 4자리 숫자로만 구성
50	trusteeCorpName	String	200	수탁자 상호
51	trusteeCEOName	String	100	수탁자 대표자 성명
52	trusteeAddr	String	300	수탁자 주소
53	trusteeBizType	String	100	수탁자 업태
54	trusteeBizClass	String	100	수탁자 종목
55	trusteeContactName	String	100	수탁자 담당자 성명
56	trusteeDeptName	String	100	수탁자 담당자 부서명
57	trusteeTEL	String	20	수탁자 담당자 연락처
58	trusteeEmail	String	100	수탁자 담당자 메일
59	modifyCode	Integer	1	수정 사유코드 1 기재사항 착오정정 2 공급가액 변동 3 환입 4 계약의 해지 5 내국신용장 사후개설 6 착오에 의한 이중발행
60	orgNTSConfirmNum	String	24	당초 국세청승인번호
61	detailList	PBHTTaxinvoiceDetail	-	품목 상세정보 → 최대 : 99건
PBHTTaxinvoiceDetail 순번 변수명 타입 길이 설명 1 serialNum Integer 2 일련번호 2 purchaseDT String 8 거래일자 → 형식 : yyyyMMdd 3 itemName String 100 품명 4 spec String 60 규격 5 qty String 12 수량 → 소수점 아래 2번째 자리까지 반환 가능 마이너스 금액 반환 가능 6 unitCost String 18 단가 → 소수점 아래 2번째 자리까지 반환 가능 마이너스 금액 반환 가능 7 supplyCost String 18 공급가액 → 마이너스 금액 반환 가능 8 tax String 18 세액 → 마이너스 금액 반환 가능 9 remark String 100 비고

예외

Err

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

4. GetXML - 수집 상세 확인 (XML)

홈택스에서 수집된 전자세금계산서 1건의 상세정보를 XML 데이터 포맷으로 제공합니다.

Function GetXML(CorpNum As String, ntsconfirmNum As String, Optional UserID As String = "") As PBHTTaxinvoiceXML

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ntsconfirmNum	String	24	Y	전자세금계산서 국세청승인번호
3	UserID	String	50	N	팝빌회원 아이디

응답

PBHTTaxinvoiceXML

순번	변수명	타입	길이	설명
1	ResultCode	Long	-	API 처리에 대한 응답코드 1 성공
2	Message	String	-	API 처리에 대한 응답메시지
3	retObject	String	-	전자세금계산서 XML 문서

예외

Err

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

5. GetPopUpURL - 전자세금계산서 팝업 URL

미리보기

홈택스에서 수집된 전자세금계산서 1건의 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,000px (최소 725px) / height = 730px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Function GetPopUpURL(CorpNum As String, ntsconfirmNum As String, Optional UserID As String = "") As String

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ntsconfirmNum	String	24	Y	전자세금계산서 국세청승인번호
3	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

Err

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

6. GetPrintURL - 전자세금계산서 인쇄 팝업 URL

미리보기

홈택스에서 수집된 전자세금계산서 1건의 인쇄 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 930px / height = 765px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Function GetPrintURL(CorpNum As String, ntsconfirmNum As String, Optional UserID As String = "") As String

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ntsconfirmNum	String	24	Y	전자세금계산서 국세청승인번호
3	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

Err

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