POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

HTTaxinvoiceJobState

순번변수명타입길이설명
jobID str 18 작업아이디
jobState str 1 수집상태
1대기
2진행
3완료
Type str 2 수집유형
매출
매입
수탁
queryDateType str 9 일자유형
WriteDate작성일자
IssueDate발행일자
SendDate전송일자
queryStDate str 8 시작일자
형식 : yyyyMMdd
queryEnDate str 8 종료일자
형식 : yyyyMMdd
errorCode int - 수집 결과 코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
errorReason str - 오류메시지
수집실패시 반환되는 사유
jobStartDT str 14 작업 시작일시
형식 : yyyyMMddHHmmss
jobEndDT str 14 작업 종료일시
형식 : yyyyMMddHHmmss
collectCount int - 수집개수
regDT str 14 수집 요청일시
형식 : yyyyMMddHHmmss

HTTaxinvoice

순번변수명타입길이설명
writeDate str 8 작성일자
형식 : yyyyMMdd
issueDT str 14 발행일시
형식 : yyyyMMddHHmmss
invoiceType int 3 전자세금계산서 종류
  • 101세금계산서
  • 102영세율 세금계산서
  • 103위수탁 세금계산서
  • 104수입 세금계산서
  • 105위수탁영세율 세금계산서
  • 201수정세금계산서
  • 202영세율 수정세금계산서
  • 203위수탁 수정세금계산서
  • 204수입 수정세금계산서
  • 205위수탁영세율 수정세금계산서
  • 301계산서
  • 303위수탁 계산서
  • 304수입 계산서
  • 401수정계산서
  • 403위수탁 수정계산서
  • 404수입 수정계산서
taxType str 2 과세형태
과세
영세
면세
taxTotal str 18 세액 합계
supplyCostTotal str 18 공급가액 합계
totalAmount str 18 합계금액
purposeType str 2 영수/청구
영수
청구
없음
serialNum str 30 일련번호
cash str 18 현금
chkBill str 18 수표
credit str 18 외상
note str 18 어음
remark1 str 150 비고1
remark2 str 150 비고2
remark3 str 150 비고3
ntsconfirmNum str 24 국세청승인번호
invoicerCorpNum str 10 공급자 사업자번호
invoicerMgtKey str 24 공급자 문서번호
invoicerTaxRegID str 4 공급자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoicerCorpName str 200 공급자 상호
invoicerCEOName str 100 공급자 대표자 성명
invoicerAddr str 300 공급자 주소
invoicerBizType str 100 공급자 업태
invoicerBizClass str 100 공급자 종목
invoicerContactName str 100 공급자 담당자 성명
invoicerDeptName str 100 공급자 담당자 부서명
invoicerTEL str 20 공급자 담당자 연락처
invoicerEmail str 100 공급자 담당자 이메일
invoiceeCorpNum str 13 공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우 사업자번호
- {invoiceeType}="개인" 경우 주민등록번호
- {invoiceeType}="외국인" 경우 "9999999999999"
invoiceeType str 3 공급받는자 구분
사업자
개인
외국인
invoiceeMgtKey str 24 공급자 문서번호
invoiceeTaxRegID str 4 공급받는자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoiceeCorpName str 200 공급받는자 상호
invoicerCEOName str 100 공급받는자 대표자 성명
invoiceeAddr str 300 공급받는자 주소
invoiceeBizType str 100 공급받는자 업태
invoiceeBizClass str 100 공급받는자 종목
invoiceeContactName1 str 100 공급받는자 주) 담당자 성명
invoiceeDeptName1 str 100 공급받는자 주) 담당자 부서명
invoiceeTEL1 str 20 공급받는자 주) 담당자 연락처
invoiceeEmail1 str 100 공급받는자 주) 담당자 이메일
invoiceeContactName2 str 100 공급받는자 부) 담당자 성명
invoiceeDeptName2 str 100 공급받는자 부) 담당자 부서명
invoiceeTEL2 str 20 공급받는자 부) 담당자 연락처
invoiceeEmail2 str 100 공급받는자 부) 담당자 이메일
trusteeCorpNum str 10 수탁자 사업자번호
trusteeMgtKey str 24 수탁자 문서번호
trusteeTaxRegID str 4 수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
trusteeCorpName str 200 수탁자 상호
trusteeCEOName str 100 수탁자 대표자 성명
trusteeAddr str 300 수탁자 주소
trusteeBizType str 100 수탁자 업태
trusteeBizClass str 100 수탁자 종목
trusteeContactName str 100 수탁자 담당자 성명
trusteeDeptName str 100 수탁자 담당자 부서명
trusteeTEL str 20 수탁자 담당자 연락처
trusteeEmail str 100 수탁자 담당자 이메일
modifyCode int 1 수정 사유코드
  • 1기재사항 착오정정
  • 2공급가액 변동
  • 3환입
  • 4계약의 해지
  • 5내국신용장 사후개설
  • 6착오에 의한 이중발행
orgNTSConfirmNum str 24 당초승인번호
detailList HTTaxinvoiceDetail[] 상세항목
최대 : 99개

HTTaxinvoiceDetail

순번변수명타입길이설명
serialNum int 2 일련번호
purchaseDT str 8 거래일자
형식 : yyyyMMdd
itemName str 100 품명
spec str 60 규격
qty str 12 수량
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능
unitCost str 18 단가
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능
supplyCost str 18 공급가액
마이너스 금액 반환 가능
tax str 18 세액
마이너스 금액 반환 가능
remark str 100 비고

HTTaxinvoiceSearchResult

순번변수명타입길이설명
code int - API 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
total int - 총 검색결과 건수
perPage int - 페이지당 목록 건수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
list HTTaxinvoiceAbbr[] 세금계산서 요약정보
최대 : 1,000건

HTTaxinvoiceAbbr

순번변수명타입길이설명
ntsconfirmNum str 24 전자세금계산서 국세청승인번호
writeDate str 8 작성일자
형식 : yyyyMMdd
issueDate str 8 발행일자
형식 : yyyyMMdd
sendDate str 8 전송일자
형식 : yyyyMMdd
taxType str 2 과세형태
과세
영세
면세
purposeType str 2 영수/청구
영수
청구
없음
supplyCostTotal str 18 공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
taxTotal str 18 세액 합계
totalAmount str 18 합계금액
remark1 str 450 비고
전자세금계산서 비고1/2/3 값의 합
invoiceType str 2 세금계산서 유형
매입
매출
modifyYN bool - 수정 전자세금계산서 여부
True수정세금계산서
False일반세금계산서
orgNTSConfirmNum str 24 당초승인번호
purchaseDate str 8 거래일자
형식 : yyyyMMdd
itemName str 100 품명
spec str 60 규격
qty str 12 수량
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능
unitCost str 18 단가
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능
supplyCost str 18 공급가액
마이너스 금액 반환 가능
tax str 18 세액
마이너스 금액 반환 가능
remark str 100 비고
invoicerCorpNum str 10 공급자 사업자번호
invoicerTaxRegID str 4 공급자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoicerCorpName str 200 공급자 상호
invoicerCEOName str 100 공급자 대표자 성명
invoicerEmail str 100 공급자 담당자 이메일
invoiceeCorpNum str 13 공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우 사업자번호
- {invoiceeType}="개인" 경우 주민등록번호
- {invoiceeType}="외국인" 경우 "9999999999999"
invoiceeType str 3 공급받는자 구분
사업자
개인
외국인
invoiceeTaxRegID str 4 공급받는자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoiceeCorpName str 200 공급받는자 상호
invoiceeCEOName str 100 공급받는자 대표자 성명
invoiceeEmail1 str 100 공급받는자 담당자 이메일
invoiceeEmail2 str 70 공급받는자 ASP 연계사업자 메일
trusteeCorpNum str 10 수탁자 사업자번호
trusteeTaxRegID str 4 수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
trusteeCorpName str 200 수탁자 상호
trusteeCEOName str 100 수탁자 대표자 성명
trusteeEmail str 100 수탁자 담당자 이메일

HTTaxinvoiceSummary

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

HTTaxinvoiceXMLResponse

순번변수명타입길이설명
ResultCode int - API 처리에 대한 응답코드
1성공
Message str 24 API 처리에 대한 응답메시지
retObject str - 전자세금계산서 XML 문서

FlatRateState

순번변수명타입길이설명
referenceID str 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 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 환불코드