POPBill Developers
API Reference

A. 객체정보

Response

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

Err

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

HTCBJobState

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

HTCashbill

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

HTCashbillSearch

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

HTCashbillSummary

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

HTCBFlatRate

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

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)
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회사권한
mgrYN boolean - 관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state Integer 1 계정상태
1사용중

RefundHistory

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

RefundHistoryResult

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

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 환불사유

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)

PaymentHistoryResult

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

UseHistoryResult

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

RefundResponse

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

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 정산코드