POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
Webhook(웹훅)

팝빌에서 발생한 이벤트 정보를
고객사 서버로 즉시 전송합니다.

API Reference
현금영수증
Java
API Reference 현금영수증 Java 객체정보

A. 객체정보

Response

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

CBIssueResponse

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

PopbillException

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

Cashbill - 입력부

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

Cashbill - 출력부

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

BulkResponse

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

BulkCashbillResult

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
submitID String 36 접수 시점에 고객사에서 할당한 제출아이디
submitCount long - 현금영수증 접수 건수
successCount long - 현금영수증 발행 성공 건수
failCount long - 현금영수증 발행 실패 건수
txState long 1 접수상태
0접수
1처리중
2처리완료
txResultCode long - 접수 결과코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
txStartDT String 14 발행처리 시작일시
형식 : yyyyMMddHHmmss
txEndDT String 14 발행처리 완료일시
형식 : yyyyMMddHHmmss
receiptDT String 14 접수일시
형식 : yyyyMMddHHmmss
issueResult List<BulkCashbillIssueResult> 발행결과
receiptID String 36 접수아이디
접수 시점에 팝빌에서 자동으로 할당

BulkCashbillIssueResult

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

CBSearchResult

순번변수명타입길이설명
code String - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
total String - 총 검색결과 건수
perPage String - 페이지당 목록 건수
pageNum String - 페이지 번호
pageCount String - 페이지 개수
list List<CashbillInfo> 현금영수증 상태/요약정보
함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일
최대 1,000건

CashbillInfo

순번변수명타입길이설명
itemKey String 18 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
mgtKey String 24 문서번호
파트너가 할당하는 식별번호
tradeDate String 8 거래일자
형식 : yyyyMMdd
tradeDT String 14 거래일시
형식 : yyyyMMddHHmmss
tradeType String 4 문서형태
승인거래
취소거래
tradeUsage String 5 거래구분
소득공제용
지출증빙용
tradeOpt String 4 거래유형
일반
도서공연
대중교통
taxationType String 3 과세형태
과세
비과세
totalAmount String 9 거래금액
issueDT String 14 발행일시
형식 : yyyyMMddHHmmss
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
stateCode int 3 상태코드
[참고] 팝빌 상태코드
stateDT String 14 상태 변경일시
형식 : yyyyMMddHHmmss
identityNum String 19 식별번호
- {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환
- {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환
itemName String 70 주문상품명
customerName String 70 구매자(고객) 성명
confirmNum String 9 국세청승인번호
현금영수증 발행 시점에 팝빌에서 자동으로 할당
orgConfirmNum String 9 당초 승인 현금영수증 국세청승인번호
{tradeType}="취소거래" 경우 반환
orgTradeDate String 8 당초 승인 현금영수증 거래일자
{tradeType}="취소거래" 경우 반환
ntssendDT String 14 국세청 전송일시
형식 : yyyyMMddHHmmss
ntsresultDT String 14 국세청 처리결과 수신일시
형식 : yyyyMMddHHmmss
ntsresultCode String 4 결과코드
[참고] 국세청 결과코드
ntsresultMessage String 30 국세청 처리결과 메시지
printYN boolean - 인쇄여부
true인쇄
false미인쇄
interOPYN boolean - 연동문서 여부
trueAPI를 통해 발행한 연동문서
false팝빌 사이트를 통해 발행한 문서

EmailSendConfig

순번변수명타입길이설명
emailType String 9 메일전송유형
CSH_ISSUE
고객에게 현금영수증이 발행 되었음을 알려주는 메일
sendYN Boolean - 전송여부
true전송
false미전송

UseHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<UseHistory> 사용내역

UseHistory

순번변수명타입길이설명
itemCode String 3 서비스 코드
  • 110세금계산서
  • 111홈택스수집(세금)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
  • 140현금영수증
  • 141홈택스수집(현금)
  • 150문자(SMS)
  • 151문자(LMS)
  • 152문자(MMS)
  • 153알림톡
  • 154친구톡(텍스트)
  • 155친구톡(이미지)
  • 160팩스(일반망)
  • 161팩스(지능망)
  • 170사업자등록상태조회
  • 171기업정보조회
  • 180계좌조회
  • 182계좌성명조회
  • 183계좌실명조회
txType String 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
txPoint String 18 증감 포인트
balance String 18 잔여포인트
txDT String 14 포인트 증감 일시
형식 : yyyyMMddHHmmss
userID String 50 담당자 아이디
userName String 100 담당자명

PaymentHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<PaymentHistory> 결제내역

PaymentHistory

순번변수명타입길이설명
productType String 3 결제 내용
포인트
정액제
미수금
productName String 30 결제 상품명
settleType String 7 결제유형
무통장
신용카드
실시간계좌이체
settlerName String 100 담당자명
settlerEmail String 100 담당자메일
settleCost String 18 결제금액
settlePoint String 18 충전포인트
settleState int 1 결제상태
  • 1대기
  • 2승인
  • 3실패
  • 45취소
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
stateDT String 14 상태일시
형식 : yyyyMMddHHmmss

RefundHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<RefundHistory> 환불내역

RefundHistory

순번변수명타입길이설명
reqDT String 14 신청일시
형식 : yyyyMMddHHmmss
requestPoint String 18 환불 신청포인트
accountBank String 10 환불계좌 은행명
accountNum String 50 환불계좌번호
accountName String 70 환불계좌 예금주명
state int 1 상태
  • 1 접수대기
  • 2 심사중
  • 3 입금대기
  • 4 환불완료
  • 5 취소
reason String 200 환불사유

RefundForm

순번변수명타입길이필수설명
contactName String 100 Y 담당자명
tel String 20 Y 담당자 연락처
requestPoint String 18 Y 환불 신청 포인트
accountBank String 10 Y 은행명
accountNum String 50 Y 계좌번호
accountName String 70 Y 예금주명
reason String 200 N 환불사유

PaymentForm

순번변수명타입길이필수설명
settlerName String 100 N 담당자명
settlerEmail String 100 N 담당자 이메일
notifyHP String 20 N 담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
paymentName String 70 Y 입금자명
settleCost String 18 Y 결제금액

PaymentResponse

순번변수명타입길이설명
code Long - 응답코드
message String - 응답메시지
settleCode String 18 정산코드

ChargeInfo

순번변수명타입길이설명
unitCost String 12 발행단가
chargeMethod String 3 과금유형
연동
파트너
rateSystem String 3 과금제도
종량제

JoinForm

순번변수명타입길이필수설명
ID String 50 Y 아이디
6자 이상 50자 이하
Password String 20 Y 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
LinkID String 20 Y 파트너 링크아이디
팝빌에서 발급한 링크아이디
CorpNum String 10 Y 사업자번호 ('-' 제외)
CEOName String 100 Y 대표자 성명
CorpName String 200 Y 회사명
Addr String 300 Y 사업장 주소
BizType String 100 Y 업태
BizClass String 100 Y 종목
ContactName String 100 Y 담당자 성명
ContactEmail String 100 Y 담당자 이메일
ContactTEL String 20 Y 담당자 휴대폰

CorpInfo

순번변수명타입길이필수설명
ceoname String 100 Y 대표자 성명
corpName String 200 Y 회사명
addr String 300 Y 주소
bizType String 100 Y 업태
bizClass String 100 Y 종목

ContactInfo - 입력부

순번변수명타입길이필수설명
id String 50 Y 아이디
6자 이상 50자 이하
password String 20 조건부 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole Integer 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번변수명타입길이설명
id String 50 아이디
personName String 100 담당자 성명
tel String 20 담당자 휴대폰
email String 100 담당자 이메일
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
searchRole Integer 1 담당자 권한
1개인권한
2읽기권한
3회사권한
mgrYN Boolean - 관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state Integer 1 계정상태
1사용중

RefundResponse

순번변수명타입길이설명
code Integer - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
refundCode String 18 환불코드