POPBill Developers
API Reference

A. 객체정보

Response

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message string - API 처리에 대한 응답메시지
confirmNum string 9 현금영수증 발행 시점에 팝빌에서 자동으로 부여
※ RegistIssue, RevokeRegistIssue API 사용할 경우만 존재
tradeDate string 8 현금영수증 발행 시점에 팝빌에서 자동으로 부여 (형식 : yyyyMMdd)
※ RegistIssue, RevokeRegistIssue API 사용할 경우만 존재

PopbillException

순번 변수명 타입 길이 비고
code long - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
[참고] 오류코드
message string - API 처리 실패에 대한 오류메시지

Cashbill

순번 변수명 타입 길이 필수 비고
mgtkey string 24 Y 문서번호
└ 현금영수증 관리를 위해 파트너가 할당하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
confirmNum string 9 X 국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여
orgConfirmNum string 9 조건부 원본 현금영수증 국세청 승인번호
└ 취소 현금영수증 작성시 필수
orgTradeDate string 9 조건부 원본 현금영수증 거래일자
└ 취소 현금영수증 작성시 필수
tradeDate string 8 X 현금영수증 발행 시점에 팝빌에서 자동으로 부여
└ {tradeDT}의 yyyyMMdd
※ 거래일자는 입력 할 수 없음
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
└ true : 전송
└ false : 미전송
※ 미입력시 기본값 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 처리

BulkCBResponse

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

BulkCBResult

순번 변수명 타입 길이 비고
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 BulkCBIssueResult[ ] 발행결과
receiptID string 36 접수아이디
└ 접수 시점에 팝빌에서 자동으로 부여

BulkCBIssueResult

순번 변수명 타입 길이 비고
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 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)
stateMemo string 200 상태메모
stateCode Integer 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 중 반환

EmailConfig

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

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 종목

Contact

순번 변수명 타입 길이 필수 비고
id string 50 Y 아이디
└ 6자 이상 50자 이하
Password string 20 조건부 비밀번호
└ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
personName string 100 Y 담당자 성명
tel string 20 Y 담당자 휴대폰
email string 100 Y 담당자 이메일
regDT string 14 X 등록일시 (형식 : yyyyMMddHHmmss)
searchRole integer 1 N 담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한
└ 2 : 읽기권한
└ 3 : 회사권한
mgrYN boolean - X 관리자 여부 : true / false 중 반환
└ true : 관리자
└ false : 담당자
└ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state string 1 X 계정상태 : "1" 반환
└ "1" : 사용중