POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
Webhook(웹훅)

팝빌에서 발생한 이벤트 정보를
고객사 서버로 즉시 전송합니다.

API Reference
홈택스수집
PHP
API Reference 홈택스수집 PHP 객체정보

A. 객체정보

Response

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

PopbillException

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

HTCBKeyType

순번변수명타입길이설명
SELL String - 매출
BUY String - 매입

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
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
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 가맹점(발행자) 사업자번호
{invoiceType}="매입" 경우 반환
franchiseCorpName String 200 가맹점(발행자) 상호
{invoiceType}="매입" 경우 반환
franchiseCorpType String 1 가맹점(발행자) 사업자유형
  • 1일반과세자
  • 2간이과세자
  • 3법인과세자
  • 4면세사업자
  • 5법인사업자
{invoiceType}="매입" 경우 반환
identityNum String 4 식별번호
반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
identityNumType String 1 식별번호 유형
  • 1주민등록번호
  • 2사업자번호
  • 3휴대전화번호
  • 4카드번호
customerName String 70 구매자(고객) 성명
cardOwnerName String 70 카드소유자명
deductionType String 1 공제유형
12 공제
34 불공제

HTCashbillSearchResult

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

HTCashbillSummary

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

HTCBFlatRate

순번변수명타입길이설명
referenceID Integer 10 사업자번호 ('-' 제외)
contractDT String 14 정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
useEndDate String 8 정액제 서비스 만료일자
형식 : yyyyMMdd
baseDate Integer - 자동연장 결제일
5
15
25
state String - 정액제 서비스 상태
1사용 또는 사용제한
2해지
closeRequestYN Boolean - 정액제 서비스 해지신청 여부
true신청
false미신청
useRestrictYN Boolean - 정액제 서비스 사용제한 여부
true사용제한
false사용
closeOnExpired Boolean - 정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
unPaidYN Boolean - 미수금 보유 여부
true보유
false미보유

UseHistoryResult

순번변수명타입길이설명
code Integer - API 처리에 대한 응답코드
1성공
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 목록 건수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
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 Integer - API 처리에 대한 응답코드
1성공
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 목록 건수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
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 Integer 1 결제상태
  • 1대기
  • 2승인
  • 3실패
  • 45취소
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
stateDT String 14 상태일시
형식 : yyyyMMddHHmmss

RefundHistoryResult

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

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

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 Integer - 응답코드
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 사업자번호 ('-' 제외)
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자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole Integer 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번변수명타입길이설명
id String 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사용중

RefundResponse

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