발행

1. RegistIssue - 승인 현금영수증 발행

작성된 현금영수증 데이터를 팝빌에 저장과 동시에 발행하여 “발행완료” 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책

def registIssue(CorpNum, cashbill, Memo, UserID=None, EmailSubject=None)

현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)
현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.

요청

Parameters

순번 변수명 타입 길이 필수 설명

CorpNum

str

팝빌회원 사업자번호 ('-' 제외)

cashbill

현금영수증 정보

Cashbill

순번	변수명	타입	길이	필수	설명
1	`mgtKey`	str	24	Y	문서번호 문서 관리를 위해 파트너가 할당하는 식별번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
2	`orgConfirmNum`	str	9	조건부	당초 국세청승인번호 취소 현금영수증 작성시 필수
3	`orgTradeDate`	str	8	조건부	당초 거래일자 취소 현금영수증 작성시 필수
4	`tradeDT`	str	14	N	거래일시 전일부터 당일까지 입력 가능 형식 : yyyyMMddHHmmss 기본값 : 발행일시 사용
5	`tradeType`	str	4	Y	문서형태 (택 1) `승인거래` `취소거래`
6	`tradeUsage`	str	5	Y	거래구분 (택 1) `소득공제용` `지출증빙용`
7	`tradeOpt`	str	4	N	거래유형 `일반` 기본값 `도서공연` `대중교통` 도서공연 : 도서, 공연, 박물관, 미술관, 수영장, 체력단련장, 신문구독료(종이신문), 영화관람료
8	`taxationType`	str	3	Y	과세형태 (택 1) `과세` `비과세`
9	`totalAmount`	str	9	Y	거래금액 (공급가액+부가세+봉사료) 양수만 입력
10	`supplyCost`	str	9	Y	공급가액 양수만 입력
11	`tax`	str	9	Y	부가세 양수 또는 0 입력
12	`serviceFee`	str	9	Y	봉사료 양수 또는 0 입력
13	`franchiseCorpNum`	str	10	Y	가맹점 사업자번호 팝빌회원 사업자번호 ('-' 제외)
14	`franchiseTaxRegID`	str	4	N	가맹점 종사업장 식별번호 종사업장 식별번호는 4자리 숫자로만 구성
15	`franchiseCorpName`	str	200	N	가맹점 상호
16	`franchiseCEOName`	str	100	N	가맹점 대표자 성명
17	`franchiseAddr`	str	400	N	가맹점 주소
18	`franchiseTEL`	str	20	N	가맹점 전화번호
19	`identityNum`	str	19	Y	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 입력 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 입력 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
20	`customerName`	str	70	N	구매자(고객) 성명
21	`itemName`	str	70	N	주문 상품명
22	`orderNumber`	str	200	N	주문번호
23	`email`	str	100	N	구매자(고객) 메일
24	`hp`	str	20	N	구매자(고객) 휴대폰
25	`smssendYN`	bool	-	N	구매자 알림문자 전송 여부 `True` 전송 `False` 미전송 : 기본값 수신자 : 구매자 휴대폰번호 {hp} 문자 전송 포인트가 차감(단, 전송실패 건은 환불)
26	`cancelType`	int	1	N	취소사유 `1` 거래취소 : 기본값 `2` 오류발급취소 `3` 기타 {tradeType}="취소거래" 경우 입력
27	`memo`	str	200	N	현금영수증 상태 이력을 관리하기 위한 메모 대량(Bulk)발행 경우 사용
28	`emailSubject`	str	300	N	현금영수증 발행 안내메일 제목 기본값 : 팝빌에서 설정한 안내메일 제목

Memo

str

200

현금영수증 상태 이력을 관리하기 위한 메모

UserID

str

팝빌회원 아이디

EmailSubject

str

300

현금영수증 발행 안내메일 제목

기본값 : 팝빌에서 설정한 안내메일 제목 사용

응답

IssueResponse

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지
3	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
4	`tradeDate`	str	8	거래일자 현금영수증 발행 시점에 팝빌에서 자동으로 할당 형식 : yyyyMMdd

예외

PopbillException

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

2. RevokeRegistIssue - 취소 현금영수증 발행

당초 승인 현금영수증의 취소거래 발행 API 입니다.

작성된 취소 현금영수증 데이터를 팝빌에 저장과 동시에 발행하여 “발행완료” 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책
부분 취소 현금영수증을 발행하는 경우 IsPartCancel 값을 true 로 설정하여 주시기 바랍니다.
당초 국세청승인번호와 거래일자는 [GetInfo – 상태확인]함수를 통해 확인 가능합니다.

def revokeRegistIssue(CorpNum, mgtKey, orgConfirmNum, orgTradeDate, smssendYN=False, memo=None, UserID=None, isPartCancel=False, cancelType=None, supplyCost=None, tax=None, serviceFee=None, totalAmount=None, emailSubject=None, tradeDT=None)

유의사항
당초 승인 현금영수증의 거래일시보다 과거의 거래일시를 입력할 수 없습니다.
취소 현금영수증의 거래금액의 합은 당초 승인 현금영수증의 거래금액을 넘을 수 없습니다.
취소 현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`mgtKey`	str	24	Y	파트너가 할당한 문서번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
3	`orgConfirmNum`	str	9	Y	당초 국세청승인번호 CashbillInfo의 변수 'confirmNum' 통해 내용 확인 가능
4	`orgTradeDate`	str	8	Y	당초 거래일자 CashbillInfo의 변수 'tradeDate'를 통해 내용 확인 가능 형식 : yyyyMMdd
5	`smssendYN`	bool	-	N	현금영수증 발행시 알림문자 전송 여부 `True` 전송 `False` 미전송 : 기본값 당초 승인 현금영수증의 구매자(고객)의 휴대폰번호 문자 전송
6	`memo`	str	200	N	현금영수증 상태 이력을 관리하기 위한 메모
7	`UserID`	str	50	N	팝빌회원 아이디
8	`isPartCancel`	bool	-	N	현금영수증 취소유형 `True` 부분 취소 `False` 전체 취소 : 기본값
9	`cancelType`	int	1	N	현금영수증 취소사유 `1` 거래취소 : 기본값 `2` 오류발급취소 `3` 기타
10	`supplyCost`	str	9	조건부	부분 취소 공급가액 양수만 입력 {isPartCancel}=true 경우 필수
11	`tax`	str	9	조건부	부분 취소 부가세 양수 또는 0 입력 {isPartCancel}=true 경우 필수
12	`serviceFee`	str	9	조건부	부분 취소 봉사료 양수 또는 0 입력 {isPartCancel}=true 경우 필수
13	`totalAmount`	str	9	조건부	부분 취소 거래금액 양수만 입력 거래금액 = 공급가액 + 부가세 + 봉사료 {isPartCancel}=true 경우 필수
14	`emailSubject`	str	300	N	현금영수증 발행 안내메일 제목 기본값 : 팝빌에서 설정한 안내메일 제목 사용
15	`tradeDT`	str	14	N	거래일시 전일부터 당일까지 입력 가능 형식 : yyyyMMddHHmmss 기본값 : 발행일시 사용

응답

IssueResponse

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지
3	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
4	`tradeDate`	str	8	거래일자 현금영수증 발행 시점에 팝빌에서 자동으로 할당 형식 : yyyyMMdd

예외

PopbillException

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

3. BulkSubmit - 초대량 발행 접수

최대 100건의 현금영수증 발행을 한번의 요청으로 접수합니다.

def bulkSubmit(CorpNum, SubmitID, cashbillList, UserID=None)

요청

Parameters

순번 변수명 타입 길이 필수 설명

CorpNum

str

팝빌회원 사업자번호 ('-' 제외)

SubmitID

str

제출아이디

영문, 숫자, '-' 조합으로 구성

cashbillList

현금영수증 목록

최대 : 100건

Cashbill[ ]

순번	변수명	타입	길이	필수	설명
1	`mgtKey`	str	24	Y	문서번호 문서 관리를 위해 파트너가 할당하는 식별번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
2	`orgConfirmNum`	str	9	조건부	당초 국세청승인번호 취소 현금영수증 작성시 필수
3	`orgTradeDate`	str	8	조건부	당초 거래일자 취소 현금영수증 작성시 필수
4	`tradeDT`	str	14	N	거래일시 전일부터 당일까지 입력 가능 형식 : yyyyMMddHHmmss 기본값 : 발행일시 사용
5	`tradeType`	str	4	Y	문서형태 (택 1) `승인거래` `취소거래`
6	`tradeUsage`	str	5	Y	거래구분 (택 1) `소득공제용` `지출증빙용`
7	`tradeOpt`	str	4	N	거래유형 `일반` 기본값 `도서공연` `대중교통` 도서공연 : 도서, 공연, 박물관, 미술관, 수영장, 체력단련장, 신문구독료(종이신문), 영화관람료
8	`taxationType`	str	3	Y	과세형태 (택 1) `과세` `비과세`
9	`totalAmount`	str	9	Y	거래금액 (공급가액+부가세+봉사료) 양수만 입력
10	`supplyCost`	str	9	Y	공급가액 양수만 입력
11	`tax`	str	9	Y	부가세 양수 또는 0 입력
12	`serviceFee`	str	9	Y	봉사료 양수 또는 0 입력
13	`franchiseCorpNum`	str	10	Y	가맹점 사업자번호 팝빌회원 사업자번호 ('-' 제외)
14	`franchiseTaxRegID`	str	4	N	가맹점 종사업장 식별번호 종사업장 식별번호는 4자리 숫자로만 구성
15	`franchiseCorpName`	str	200	N	가맹점 상호
16	`franchiseCEOName`	str	100	N	가맹점 대표자 성명
17	`franchiseAddr`	str	400	N	가맹점 주소
18	`franchiseTEL`	str	20	N	가맹점 전화번호
19	`identityNum`	str	19	Y	식별번호 {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 입력 {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 입력 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
20	`customerName`	str	70	N	구매자(고객) 성명
21	`itemName`	str	70	N	주문 상품명
22	`orderNumber`	str	200	N	주문번호
23	`email`	str	100	N	구매자(고객) 메일
24	`hp`	str	20	N	구매자(고객) 휴대폰
25	`smssendYN`	bool	-	N	구매자 알림문자 전송 여부 `True` 전송 `False` 미전송 : 기본값 수신자 : 구매자 휴대폰번호 {hp} 문자 전송 포인트가 차감(단, 전송실패 건은 환불)
26	`cancelType`	int	1	N	취소사유 `1` 거래취소 : 기본값 `2` 오류발급취소 `3` 기타 {tradeType}="취소거래" 경우 입력
27	`memo`	str	200	N	현금영수증 상태 이력을 관리하기 위한 메모 대량(Bulk)발행 경우 사용
28	`emailSubject`	str	300	N	현금영수증 발행 안내메일 제목 기본값 : 팝빌에서 설정한 안내메일 제목

UserID

str

팝빌회원 아이디

응답

BulkResponse

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지
3	`receiptID`	str	36	접수아이디 접수 시점에 팝빌에서 자동으로 할당

예외

PopbillException

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

4. GetBulkResult - 초대량 접수결과 확인

접수시 기재한 SubmitID를 사용하여 현금영수증 접수결과를 확인합니다.

개별 현금영수증 처리상태는 접수상태(txState)가 완료(2) 시 반환됩니다.

def getBulkResult(CorpNum, SubmitID, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`SubmitID`	str	36	Y	파트너가 할당한 제출아이디
3	`UserID`	str	50	N	팝빌회원 아이디

응답

BulkCashbillResult

순번 변수명 타입 길이 설명

code

int

API 처리에 대한 응답코드

1 성공

message

str

API 처리에 대한 응답메시지

submitID

str

접수 시점에 고객사에서 할당한 제출아이디

submitCount

int

현금영수증 접수 건수

successCount

int

현금영수증 발행 성공 건수

failCount

int

현금영수증 발행 실패 건수

txState

int

접수상태

0 접수
1 처리중
2 처리완료

txResultCode

int

접수 결과코드

성공 : 1

실패 : 음의 정수 8자리 숫자값

[참고] 오류코드

txStartDT

str

발행처리 시작일시

형식 : yyyyMMddHHmmss

txEndDT

str

발행처리 완료일시

형식 : yyyyMMddHHmmss

receiptDT

str

접수일시

형식 : yyyyMMddHHmmss

receiptID

str

접수아이디

접수 시점에 팝빌에서 자동으로 할당

issueResult

발행결과

BulkCashbillIssueResult[ ]

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지
3	`mgtKey`	str	24	문서번호
4	`confirmNum`	str	9	국세청승인번호 현금영수증 발행 시점에 팝빌에서 자동으로 할당
5	`tradeDate`	str	8	거래일자 현금영수증 발행 시점에 팝빌에서 자동으로 할당 형식 : yyyyMMdd
6	`issueDT`	str	14	발행일시 형식 : yyyyMMddHHmmss

예외

PopbillException

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

5. Delete - 삭제

삭제 가능한 상태의 현금영수증을 삭제합니다.
※ 삭제 가능한 상태: “전송실패”

def delete(CorpNum, MgtKey, UserID=None)

삭제 처리된 현금영수증의 문서번호는 재사용이 가능합니다.

요청

Parameters

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

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

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