POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

BizCheckInfo

순번변수명타입길이설명
corpNum str 10 사업자번호
companyRegNum str 13 법인등록번호
checkDT str 14 기업정보조회일시
형식 : yyyyMMddHHmmss
corpName str 256 상호
CEOName str 128 대표자명
corpCode int 3 기업형태코드
  • 100일반회사
  • 101신설회사
  • 102외감
  • 103피합병
  • 110거래소(상장)
  • 111거래소(관리)
  • 112코스닥(등록)
  • 113코스닥(관리)
  • 114코넥스
  • 200폐업
  • 201부도
  • 300휴업
  • 900미정의
  • 999기타
corpScaleCode int 2 기업규모코드
  • 10대기업
  • 11대기업(금융)
  • 20중견기업
  • 21중견기업(하)
  • 30중소기업
  • 90기타(비영리법인)
  • 99기타
personCorpCode int 2 개인/법인코드
1법인
2개인
99기타
headOfficeCode int 2 본점/지점코드
1본점
2지점
99기타
industryCode str 6 산업코드
한국표준산업분류(10차) 기준
establishDate str 8 설립일자
형식 : yyyyMMdd
establishCode int 2 설립코드
  • 1주식
  • 2합자
  • 3합명
  • 4유한
  • 5조합
  • 6정부투자기관
  • 7개인
  • 8학교
  • 9병원
  • 10단체 또는 협회
  • 11미정의
  • 99기타
workPlaceCode int 2 사업장코드
  • 10본사
  • 20공장
  • 30서울사무소
  • 31사무소
  • 32영업소
  • 33지점
  • 34출장소
  • 40연구소
  • 50건설공장
  • 60창고
  • 99기타
addrCode int 2
  • 1도로명
  • 2지번
  • 3입력(입수)
  • 99기타
zipCode str 6 우편번호
addr str 256 주소
addrDetail str 256 상세주소
enAddr str 256 영문주소
bizClass str 4096 업종
bizType str 4096 업태
result int 3 상태코드
resultMessage str 4096 상태메시지
closeDownState int 1
  • 0미등록
  • 1사업중
  • 2폐업
  • 3휴업
  • 9확인실패
closeDownStateDate str 8 휴폐업일자
형식 : yyyyMMdd
closeDownTaxType int 2 과세유형
None미등록
10일반과세자
20면세과세자
30간이과세자
31간이과세자 세금계산서 발급사업자
40비영리법인 또는 국가기관, 고유번호가 할당된 단체
99확인실패
closeDownTaxTypeDate str 8 과세유형 전환일자
형식 : yyyyMMdd

UseHistoryResult

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

UseHistory

순번변수명타입길이설명
itemCode str 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 str 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
txPoint str 18 증감 포인트
balance str 18 잔여포인트
txDT str 14 포인트 증감 일시
형식 : yyyyMMddHHmmss
userID str 50 담당자 아이디
userName str 100 담당자명

PaymentHistoryResult

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

PaymentHistory

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

RefundHistoryResult

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

RefundHistory

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

RefundForm

순번변수명타입길이필수설명
ContactName str 100 Y 담당자명
tel str 20 Y 담당자 연락처
RequestPoint str 18 Y 환불 신청 포인트
AccountBank str 10 Y 은행명
AccountNum str 50 Y 계좌번호
AccountName str 70 Y 예금주명
Reason str 200 N 환불사유

PaymentForm

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

PaymentResponse

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

ChargeInfo

순번변수명타입길이설명
unitCost str - 조회단가
chargeMethod str 3 과금유형
연동
파트너
rateSystem str 3 과금제도
종량제

JoinForm

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

CorpInfo

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

ContactInfo - 입력부

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

ContactInfo - 출력부

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

RefundResponse

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