POPBill Developers
API Reference

A. 객체정보

Response

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

CBIssueResponse

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
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 문서형태 : "승인거래" / "취소거래" 중 입력
└ "승인거래" 현금영수증은 [RegistIssue - 즉시 발행]함수 사용하여 발행
└ "취소거래" 현금영수증은 [RevokeRegistIssue - 취소 현금영수증 즉시발행]함수 사용하여 발행
tradeUsage String - Y 거래구분 : "소득공제용" / "지출증빙용" 중 택 1
tradeOpt String 4 N 거래유형 : "일반" / "도서공연" / "대중교통" 중 택 1
└ 미입력시 기본값 "일반" 처리
taxationType String - Y "과세" / "비과세" 중 택 1
totalAmount String 9 Y 거래금액
└ 양수만 입력
supplyCost String 9 Y 공급가액
└ 양수만 입력
tax String 9 Y 부가세
└ 양수만 입력
serviceFee String 9 Y 봉사료
└ 양수만 입력
franchiseCorpNum String 10 Y 가맹점 사업자번호
└ 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
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} 값이 true 인 경우 이 값으로 안내 문자 전송
smssendYN boolean - N SMS 전송여부 true : (전송) / false : (미전송) 중 택1
※ 미입력시 기본값 false처리
faxsendYN boolean - N FAX 전송여부 : true / false 중 택1
└ true : 전송
└ false : 미전송
※ 미입력시 기본값 false처리
cancelType Integer 1 N 취소사유 : null / 1 / 2 / 3 중 택 1
└ null : 일반 현금영수증
└ 1 : 거래취소
└ 2 : 오류발급취소
└ 3 : 기타
※ 취소 현금영수증 발행시 미입력하면 기본값 1 처리

Cashbill - 출력부

순번 변수명 타입 길이 비고
mgtKey String 24 문서번호
└ 현금영수증 관리를 위해 파트너가 할당하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
confirmNum String 9 국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여
orgConfirmNum String 9 당초 승인 현금영수증 국세청 승인번호
└ 취소 현금영수증 작성시 필수
orgTradeDate String 9 당초 승인 현금영수증 거래일자
└ 취소 현금영수증 작성시 필수
tradeDate String 8 현금영수증 발행 시점에 팝빌에서 자동으로 부여
└ {tradeDT}의 yyyyMMdd
※ 거래일자는 입력 할 수 없음
tradeDT String 14 거래일시 (형식 : yyyyMMddHHmmss)
└ 전날부터 당일까지 입력가능
※ 미입력시 기본값 발행일시 처리
tradeType String 4 문서형태 : "승인거래" / "취소거래" 중 입력
└ "승인거래" 현금영수증은 [RegistIssue - 즉시 발행]함수 사용하여 발행
└ "취소거래" 현금영수증은 [RevokeRegistIssue - 취소 현금영수증 즉시발행]함수 사용하여 발행
tradeUsage String 5 거래구분 : "소득공제용" / "지출증빙용" 중 택 1
tradeOpt String 4 거래유형 : "일반" / "도서공연" / "대중교통" 중 택 1
└ 미입력시 기본값 "일반" 처리
taxationType String 3 "과세" / "비과세" 중 택 1
totalAmount String 9 거래금액
└ 양수만 입력
supplyCost String 9 공급가액
└ 양수만 입력
tax String 9 부가세
└ 양수만 입력
serviceFee String 9 봉사료
└ 양수만 입력
franchiseCorpNum String 10 가맹점 사업자번호
└ 팝빌회원 사업자번호 (하이픈 '-' 제외 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} 값이 "지출증빙용" 인 경우
└ 사업자번호/휴대폰/카드번호 입력
※ 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
customerName String 70 구매자(고객) 성명
itemName String 70 주문 상품명
orderNumber String 200 주문번호
email String 100 구매자(고객) 이메일
hp String 20 구매자(고객) 휴대폰
└ {smssendYN} 값이 true 인 경우 이 값으로 안내 문자 전송
smssendYN boolean - SMS 전송여부 true : (전송) / false : (미전송) 중 택1
※ 미입력시 기본값 false처리
faxsendYN boolean - FAX 전송여부 : true / false 중 택1
└ true : 전송
└ false : 미전송
※ 미입력시 기본값 false처리
cancelType Integer 1 취소사유 : null / 1 / 2 / 3 중 택 1
└ null : 일반 현금영수증
└ 1 : 거래취소
└ 2 : 오류발급취소
└ 3 : 기타
※ 취소 현금영수증 발행시 미입력하면 기본값 1 처리

BulkResponse

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
receiptID String 24 접수아이디
└ 접수 시점에 팝빌에서 자동으로 부여

BulkCashbillResult

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
submitID String 36 접수 시점에 고객사에서 부여한 제출아이디
submitCount long - 현금영수증 접수 건수
successCount long - 현금영수증 발행 성공 건수
failCount long - 현금영수증 발행 실패 건수
txState long 1 접수상태 : 0 / 1 / 2 중 반환
└ 0 : 접수
└ 1 : 처리중
└ 2 : 처리완료
txResultCode long - 접수 결과코드
txStartDT String 14 발행처리 시작일시 (형식 : yyyyMMddHHmmss)
txEndDT String 14 발행처리 완료일시 (형식 : yyyyMMddHHmmss)
receiptDT String 14 접수일시 (형식 : yyyyMMddHHmmss)
issueResult List<BulkCashbillIssueResult> 발행결과
receiptID String 36 접수아이디
└ 접수 시점에 팝빌에서 자동으로 부여

BulkCashbillIssueResult

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
mgtKey String 24 문서번호
confirmNum String 9 국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여
tradeDate String 8 거래일자 (형식 : yyyyMMdd)
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여
※ 미입력시 기본값 발행일시 처리
issueDT String 14 발행일시 (형식 : yyyyMMddHHmmss)

CBSearchResult

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

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 - 연동문서 여부 : true / false 중 반환
└ true : API를 통해 발행한 연동문서
└ false : 팝빌 사이트를 통해 발행한 문서

EmailSendConfig

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

UseHistoryResult

순번변수명타입길이비고
code Long - API 처리에 대한 응답코드
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 처리에 대한 응답코드
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 / 4 / 5 중 반환
└ 1 : 대기
└ 2 : 승인
└ 3 : 실패
└ 4,5 : 취소
regDT String 14 등록일시 (형식 : yyyyMMddHHmmss)
stateDT String 14 상태일시 (형식 : yyyyMMddHHmmss)

RefundHistoryResult

순번변수명타입길이비고
code Long - API 처리에 대한 응답코드
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 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
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자 이하
└ 영문, 숫자, 특수문자 조합
└ 담당자 추가시 필수
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole Integer 1 N 담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한
└ 2 : 읽기권한
└ 3 : 회사권한 : 기본값

ContactInfo - 출력부

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

RefundResponse

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