정보확인

1. GetInfo - 상태 확인

현금영수증 1건의 상태 및 요약정보를 확인합니다.

응답 객체 CashbillInfo 의 변수 ‘stateCode’를 통해 현금영수증의 상태코드를 확인합니다.

def getInfo(CorpNum, MgtKey)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`MgtKey`	str	24	Y	파트너가 할당한 문서번호

응답

CashbillInfo

순번	변수명	타입	길이	설명
1	`itemKey`	str	18	팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
2	`mgtKey`	str	24	문서번호 파트너가 할당하는 식별번호
3	`tradeDate`	str	8	거래일자 형식 : yyyyMMdd
4	`tradeDT`	str	14	거래일시 형식 : yyyyMMddHHmmss
5	`tradeType`	str	4	문서형태 `승인거래` `취소거래`
6	`tradeUsage`	str	5	거래구분 `소득공제용` `지출증빙용`
7	`tradeOpt`	str	4	거래유형 `일반` `도서공연` `대중교통`
8	`taxationType`	str	3	과세형태 `과세` `비과세`
9	`totalAmount`	str	9	거래금액 (공급가액+부가세+봉사료)
10	`supplyCost`	str	9	공급가액
11	`tax`	str	9	부가세
12	`serviceFee`	str	9	봉사료
13	`issueDT`	str	14	발행일시 형식 : yyyyMMddHHmmss
14	`regDT`	str	14	등록일시 형식 : yyyyMMddHHmmss
15	`stateMemo`	str	200	상태메모
16	`stateCode`	int	3	상태코드 [참고] 팝빌 상태코드
17	`stateDT`	str	14	상태 변경일시 형식 : yyyyMMddHHmmss
18	`identityNum`	str	19	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환
19	`itemName`	str	70	주문상품명
20	`orderNumber`	str	200	주문번호
21	`email`	str	100	구매자 이메일
22	`hp`	str	20	구매자 휴대폰
23	`customerName`	str	70	구매자(고객) 성명
24	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
25	`orgConfirmNum`	str	9	당초 국세청승인번호 {tradeType}="취소거래" 경우 반환
26	`orgTradeDate`	str	8	당초 거래일자 {tradeType}="취소거래" 경우 반환
27	`ntssendDT`	str	14	국세청 전송일시 형식 : yyyyMMddHHmmss
28	`ntsresultDT`	str	14	국세청 처리결과 수신일시 형식 : yyyyMMddHHmmss
29	`ntsresultCode`	str	4	국세청 결과코드 [참고] 국세청 결과코드
30	`ntsresultMessage`	str	30	국세청 결과메시지
31	`printYN`	bool	-	인쇄여부 `True` 인쇄 `False` 미인쇄
32	`interOPYN`	bool	-	연동문서 여부 `True` API를 통해 발행한 연동문서 `False` 팝빌 사이트를 통해 발행한 문서

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

2. GetInfos - 다수건 상태 확인

다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출에 최대 1,000건 확인 가능)

리턴값 CashbillInfo 의 변수 ‘stateCode’를 통해 현금영수증의 상태코드를 확인합니다.

def getInfos(CorpNum, MgtKeyList)

문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`MgtKeyList`	list	1,000	Y	문서번호 목록 최대 : 1,000건

응답

list[CashbillInfo]

순번	변수명	타입	길이	설명
1	`itemKey`	str	18	팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
2	`mgtKey`	str	24	문서번호 파트너가 할당하는 식별번호
3	`tradeDate`	str	8	거래일자 형식 : yyyyMMdd
4	`tradeDT`	str	14	거래일시 형식 : yyyyMMddHHmmss
5	`tradeType`	str	4	문서형태 `승인거래` `취소거래`
6	`tradeUsage`	str	5	거래구분 `소득공제용` `지출증빙용`
7	`tradeOpt`	str	4	거래유형 `일반` `도서공연` `대중교통`
8	`taxationType`	str	3	과세형태 `과세` `비과세`
9	`totalAmount`	str	9	거래금액 (공급가액+부가세+봉사료)
10	`supplyCost`	str	9	공급가액
11	`tax`	str	9	부가세
12	`serviceFee`	str	9	봉사료
13	`issueDT`	str	14	발행일시 형식 : yyyyMMddHHmmss
14	`regDT`	str	14	등록일시 형식 : yyyyMMddHHmmss
15	`stateMemo`	str	200	상태메모
16	`stateCode`	int	3	상태코드 [참고] 팝빌 상태코드
17	`stateDT`	str	14	상태 변경일시 형식 : yyyyMMddHHmmss
18	`identityNum`	str	19	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환
19	`itemName`	str	70	주문상품명
20	`orderNumber`	str	200	주문번호
21	`email`	str	100	구매자 이메일
22	`hp`	str	20	구매자 휴대폰
23	`customerName`	str	70	구매자(고객) 성명
24	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
25	`orgConfirmNum`	str	9	당초 국세청승인번호 {tradeType}="취소거래" 경우 반환
26	`orgTradeDate`	str	8	당초 거래일자 {tradeType}="취소거래" 경우 반환
27	`ntssendDT`	str	14	국세청 전송일시 형식 : yyyyMMddHHmmss
28	`ntsresultDT`	str	14	국세청 처리결과 수신일시 형식 : yyyyMMddHHmmss
29	`ntsresultCode`	str	4	국세청 결과코드 [참고] 국세청 결과코드
30	`ntsresultMessage`	str	30	국세청 결과메시지
31	`printYN`	bool	-	인쇄여부 `True` 인쇄 `False` 미인쇄
32	`interOPYN`	bool	-	연동문서 여부 `True` API를 통해 발행한 연동문서 `False` 팝빌 사이트를 통해 발행한 문서

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

3. GetDetailInfo - 상세정보 확인

현금영수증 1건의 상세정보를 확인합니다.

def getDetailInfo(CorpNum, MgtKey)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`MgtKey`	str	24	Y	파트너가 할당한 문서번호

응답

Cashbill

순번	변수명	타입	길이	설명
1	`mgtKey`	str	24	문서번호 문서 관리를 위해 파트너가 할당하는 식별번호
2	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
3	`orgConfirmNum`	str	9	당초 국세청승인번호 {tradeType}="취소거래" 경우 반환
4	`orgTradeDate`	str	8	당초 거래일자 {tradeType}="취소거래" 경우 반환
5	`tradeDate`	str	8	거래일자 현금영수증 발행 시점에 팝빌에서 자동으로 할당 {tradeDT}의 yyyyMMdd
6	`tradeDT`	str	14	거래일시 형식 : yyyyMMddHHmmss
7	`tradeType`	str	4	문서형태 `승인거래` `취소거래`
8	`tradeUsage`	str	5	거래구분 `소득공제용` `지출증빙용`
9	`tradeOpt`	str	4	거래유형 `일반` `도서공연` `대중교통`
10	`taxationType`	str	3	과세형태 `과세` `비과세`
11	`totalAmount`	str	9	거래금액 (공급가액+부가세+봉사료)
12	`supplyCost`	str	9	공급가액
13	`tax`	str	9	부가세
14	`serviceFee`	str	9	봉사료
15	`franchiseCorpNum`	str	10	가맹점 사업자번호 팝빌회원 사업자번호 ('-' 제외)
16	`franchiseTaxRegID`	str	4	가맹점 종사업장 식별번호 종사업장 식별번호는 4자리 숫자로만 구성
17	`franchiseCorpName`	str	200	가맹점 상호
18	`franchiseCEOName`	str	100	가맹점 대표자 성명
19	`franchiseAddr`	str	400	가맹점 주소
20	`franchiseTEL`	str	20	가맹점 전화번호
21	`identityNum`	str	19	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환
22	`customerName`	str	70	구매자(고객) 성명
23	`itemName`	str	70	주문 상품명
24	`orderNumber`	str	200	주문번호
25	`email`	str	100	구매자(고객) 메일
26	`hp`	str	20	구매자(고객) 휴대폰
27	`smssendYN`	bool	-	구매자 알림문자 전송 여부 `True` 전송 `False` 미전송 : 기본값 수신자 : 구매자 휴대폰번호 {hp}
28	`cancelType`	int	1	취소사유 `1` 거래취소 `2` 오류발급취소 `3` 기타 {tradeType}="취소거래" 경우 반환

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

4. CheckMgtKeyInUse - 문서번호 사용 여부 확인

파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.

이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.

def checkMgtKeyInUse(CorpNum, MgtKey)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`MgtKey`	str	24	Y	확인할 문서번호

응답

bool - True : (사용중) / False : (미사용중)

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

5. Search - 목록 조회

검색조건에 해당하는 현금영수증을 조회합니다. (최대 조회기간 : 6개월)

def search(CorpNum, DType, SDate, EDate, State, TradeType, TradeUsage, TaxationType, Page, PerPage, Order, UserID=None, Qstr=None, TradeOpt=None, FranchiseTaxRegID=None)

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

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`DType`	str	1	Y	검색일자 유형 (택 1) `R` 등록일자 `T` 거래일자 `I` 발행일시
3	`SDate`	str	8	Y	검색 시작일자 형식 : yyyyMMdd
4	`EDate`	str	8	Y	검색 종료일자 형식 : yyyyMMdd
5	`State`	list	-	N	현금영수증 상태코드 2, 3번째 자리에 와일드카드() 사용가능. 예) "3*" [참고] 팝빌 상태코드 기본값 : 전체조회
6	`TradeType`	list	-	N	현금영수증 문서형태 (다중 선택 가능) `N` 승인 현금영수증 `C` 취소 현금영수증 기본값 : 전체조회
7	`TradeUsage`	list	-	N	거래구분 (다중 선택 가능) `P` 소득공제용 `C` 지출증빙용 기본값 : 전체조회
8	`TaxationType`	list	-	N	과세형태 (다중 선택 가능) `T` 과세 `N` 비과세 기본값 : 전체조회
9	`Page`	int	-	N	목록 페이지번호 기본값 : 1
10	`PerPage`	int	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
11	`Order`	str	1	N	조회 기준일자 유형을 기준으로 하는 목록 정렬 방향 `D` 내림차순 : 기본값 `A` 오름차순
12	`UserID`	str	50	N	팝빌회원 아이디
13	`Qstr`	str	-	N	조회 검색어(식별번호) 기본값 : 전체조회
14	`TradeOpt`	list	-	N	거래유형 (다중 선택 가능) `N` 일반 `B` 도서공연 `T` 대중교통 기본값 : 전체조회
15	`FranchiseTaxRegID`	str	-	N	가맹점 종사업장번호 다수건 검색시 콤마(',')로 구분. 예) 1234,1000 기본값 : 전체조회

응답

CBSearchResult

순번 변수명 타입 길이 설명

code

int

API 처리에 대한 응답코드

1 성공

message

str

API 처리에 대한 응답메시지

total

int

총 검색결과 건수

perPage

int

페이지당 목록 건수

pageNum

int

페이지 번호

pageCount

int

페이지 개수

list

현금영수증 상태/요약정보

함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일

최대 1,000건

CashbillInfo[ ]

순번	변수명	타입	길이	설명
1	`itemKey`	str	18	팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
2	`mgtKey`	str	24	문서번호 파트너가 할당하는 식별번호
3	`tradeDate`	str	8	거래일자 형식 : yyyyMMdd
4	`tradeDT`	str	14	거래일시 형식 : yyyyMMddHHmmss
5	`tradeType`	str	4	문서형태 `승인거래` `취소거래`
6	`tradeUsage`	str	5	거래구분 `소득공제용` `지출증빙용`
7	`tradeOpt`	str	4	거래유형 `일반` `도서공연` `대중교통`
8	`taxationType`	str	3	과세형태 `과세` `비과세`
9	`totalAmount`	str	9	거래금액 (공급가액+부가세+봉사료)
10	`supplyCost`	str	9	공급가액
11	`tax`	str	9	부가세
12	`serviceFee`	str	9	봉사료
13	`issueDT`	str	14	발행일시 형식 : yyyyMMddHHmmss
14	`regDT`	str	14	등록일시 형식 : yyyyMMddHHmmss
15	`stateMemo`	str	200	상태메모
16	`stateCode`	int	3	상태코드 [참고] 팝빌 상태코드
17	`stateDT`	str	14	상태 변경일시 형식 : yyyyMMddHHmmss
18	`identityNum`	str	19	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환
19	`itemName`	str	70	주문상품명
20	`orderNumber`	str	200	주문번호
21	`email`	str	100	구매자 이메일
22	`hp`	str	20	구매자 휴대폰
23	`customerName`	str	70	구매자(고객) 성명
24	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
25	`orgConfirmNum`	str	9	당초 국세청승인번호 {tradeType}="취소거래" 경우 반환
26	`orgTradeDate`	str	8	당초 거래일자 {tradeType}="취소거래" 경우 반환
27	`ntssendDT`	str	14	국세청 전송일시 형식 : yyyyMMddHHmmss
28	`ntsresultDT`	str	14	국세청 처리결과 수신일시 형식 : yyyyMMddHHmmss
29	`ntsresultCode`	str	4	국세청 결과코드 [참고] 국세청 결과코드
30	`ntsresultMessage`	str	30	국세청 결과메시지
31	`printYN`	bool	-	인쇄여부 `True` 인쇄 `False` 미인쇄
32	`interOPYN`	bool	-	연동문서 여부 `True` API를 통해 발행한 연동문서 `False` 팝빌 사이트를 통해 발행한 문서

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

6. GetURL - 문서함 팝업 URL

문서함 팝업 URL 미리보기

현금영수증 문서함의 팝업 URL을 반환합니다.

권장 사이즈 : width = 1,280px (최소 1,000px) / height = 800px
반환되는 URL은 30초 동안만 사용이 가능합니다.
반환되는 URL은 팝빌회원의 로그인 세션을 포함하고 있으니 사용에 유의하여 주시기 바랍니다.

def getURL(CorpNum, UserID, ToGo)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`UserID`	str	50	N	팝빌회원 아이디
3	`ToGo`	str	-	Y	접근 메뉴 (택 1) `TBOX` 임시 문서함 `PBOX` 발행 문서함 `WRITE` 현금영수증 작성

응답

str - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지