POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

HTCashbillJobState

순번 변수명 타입 길이 비고
jobID str 18 작업아이디
jobState str 1 수집상태
└ "1" : (대기) / "2" : (진행) / "3" : (완료) 중 반환
Type str - 수집유형
└ "매출" / "매입" 중 반환
queryDateType str 9 수집 일자 유형
└ "TradeDate" : (거래일자) 반환
queryStDate str 8 시작일자 (형식 : yyyyMMdd)
queryEnDate str 8 종료일자 (형식 : yyyyMMdd)
errorCode int - 수집 결과코드 : 1 또는 오류코드 반환
└ 1 : 수집성공
errorReason str - 오류메시지
└ 수집실패시 반환되는 사유
jobStartDT str 14 작업 시작일시 (형식 : yyyyMMddHHmmss)
jobEndDT str 14 작업 종료일시 (형식 : yyyyMMddHHmmss)
collectCount int - 수집개수
regDT str 14 수집 요청일시 (형식 : yyyyMMddHHmmss)

HTCashbill

순번 변수명 타입 길이 비고
ntsconfirmNum str 24 국세청승인번호
tradeDate str 8 거래일자 (형식 : yyyyMMdd)
tradeDT str 14 거래일시 (형식 : yyyyMMddHHmmss)
tradeType str 4 문서형태
└ "승인거래" / "취소거래" 중 반환
tradeUsage str 5 거래구분
└ "소득공제용" / "지출증빙용" 중 반환
totalAmount str 9 거래금액
supplyCost str 9 공급가액
tax str 9 부가세
serviceFee str 9 봉사료
invoiceType str 2 "매입" / "매출" 중 반환
franchiseCorpNum str 10 가맹점(발행자) 사업자번호
※ 매입 현금영수증 조회시 반환
franchiseCorpName str 200 가맹점(발행자) 상호
※ 매입 현금영수증 조회시 반환
franchiseCorpType str 1 가맹점(발행자) 사업자유형 : "1" : (일반과세자) / "2" : (간이과세자) / "5" : (법인과세자) 중 반환
※ 매입 현금영수증 조회시 반환
identityNum str 4 식별번호
└ ※ 반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
identityNumType str 1 식별번호유형
└ "1" : (주민등록번호) / "2" : (사업자번호) / "3" : (휴대전화번호) / "4" : (카드번호) 중 반환
customerName str 70 고객명
cardOwnerName str 70 카드소유자명
deductionType str 1 공제유형
└ "1" or "2" : (공제) / "3" or "4" : (불공제) 중 반환

HTCashbillSearchResult

순번 변수명 타입 길이 비고
code int - API 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
list HTCashbill[] 현금영수증 정보 (최대 1,000건)

HTCashbillSummary

순번 변수명 타입 길이 비고
count int - 수집 결과 건수
supplyCostTotal int 18 공급가액 합계
taxTotal int 18 세액 합계
serviceFeeTotal int 18 봉사료 합계
amountTotal int 18 합계 금액

FlatRateState

순번 변수명 타입 길이 비고
referenceID str 10 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
contractDT str 14 정액제 서비스 시작일시 (형식 : yyyyMMddHHmmss)
useEndDate str 8 정액제 서비스 종료일자 (형식 : yyyyMMdd)
baseDate int 2 자동연장 결제일
└ 5 / 15 / 25 중 반환
state int 1 정액제 서비스 상태
└ 1 : (사용) / 2 : (해지) 중 반환
closeRequestYN bool - 정액제 서비스 해지신청 여부
└ True : (신청) / False : (미신청) 중 반환
useRestrictYN bool - 정액제 서비스 사용제한 여부
└ True : (제한) / False : (미제한) 중 반환
closeOnExpired bool - 정액제 서비스 만료시 해지 여부
└ True : (해지) / False : (미해지) 중 반환
unPaidYN bool - 미수금 보유 여부
└ True : (보유) / False : (미보유) 중 반환

UseHistoryResult

순번변수명타입길이비고
code Long - API 처리에 대한 응답코드
total Long - 총 검색결과 건수
perPage Long - 페이지당 검색개수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
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 Long - API 처리에 대한 응답코드
total Long - 총 검색결과 건수
perPage Long - 페이지당 검색개수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
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 / 4 / 5 중 반환
└ 1 : 대기
└ 2 : 승인
└ 3 : 실패
└ 4,5 : 취소
regDT str 14 등록일시 (형식 : yyyyMMddHHmmss)
stateDT str 14 상태일시 (형식 : yyyyMMddHHmmss)

RefundHistoryResult

순번변수명타입길이비고
code Long - API 처리에 대한 응답코드
total Long - 총 검색결과 건수
perPage Long - 페이지당 검색개수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
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 str - 응답코드
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 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
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자 이하
영문, 숫자, 특수문자 조합
담당자 추가시 필수
personName str 100 Y 담당자 성명
tel str 20 Y 담당자 휴대폰
email str 100 Y 담당자 이메일
searchRole int 1 N 담당자 권한 (택 1)
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번 변수명 타입 길이 비고
id str 50 아이디
6자 이상 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 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
refundCode str 18 환불코드