POPBill Developers
API Reference

A. 객체정보

Response

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
message String - API 처리에 대한 응답메시지

IssueResponse

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
message String - API 처리에 대한 응답메시지
ntsConfirmNum String 24 국세청 승인번호
세금계산서 발행 시점에 팝빌에서 자동으로 부여

PopbillException

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

MgtKeyType

순번 변수명 타입 길이 비고
SELL enum - 매출
BUY enum - 매입
TRUSTEE enum - 위수탁

Taxinvoice - 입력부

순번 변수명 타입 길이 필수 비고
issueType String 3 Y 발행형태 (택 1)
정발행
역발행
위수탁
taxType String 2 Y 과세형태 (택 1)
과세
영세
면세
chargeDirection String 3 Y 과금방향 (택 1)
정과금 공급자 과금
역과금 공급받는자 과금
serialNum String 30 N 일련번호
kwon Short 4 N 책번호 "권" 항목
ho Short 4 N 책번호 "호" 항목
writeDate String 8 Y 작성일자
형식 : yyyyMMdd
purposeType String 2 Y 결제대금 수취여부 (택 1)
영수
청구
없음
supplyCostTotal String 18 Y 공급가액 합계
정수만 입력 가능(소수점 자동 절사)
taxTotal String 18 Y 세액 합계
정수만 입력 가능(소수점 자동 절사)
totalAmount String 18 Y 합계금액
정수만 입력 가능(소수점 자동 절사)
cash String 18 N 현금
chkBill String 18 N 수표
credit String 18 N 외상
note String 18 N 어음
remark1 String 150 조건부 비고1
remark2 String 150 N 비고2
remark3 String 150 N 비고3
invoicerMgtKey String 24 조건부 공급자 문서번호
문서 관리를 위해 파트너가 할당하는 고유 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
invoicerCorpNum String 10 Y 공급자 사업자번호 ('-' 제외)
invoicerTaxRegID String 4 N 공급자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoicerCorpName String 200 Y 공급자 상호
invoicerCEOName String 100 Y 공급자 대표자 성명
invoicerAddr String 300 N 공급자 주소
invoicerBizType String 100 N 공급자 업태
invoicerBizClass String 100 N 공급자 종목
invoicerContactName String 100 N 공급자 담당자 성명
invoicerDeptName String 100 N 공급자 담당자 부서명
invoicerTEL String 20 N 공급자 담당자 연락처
invoicerHP String 20 N 공급자 담당자 휴대폰
invoicerEmail String 100 N 공급자 담당자 이메일
invoicerSMSSendYN Boolean - N 공급자 알림문자 전송 여부
true전송
false미전송 : 기본값
수신자 : 공급받는자 휴대폰번호 {invoiceeHP1}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
invoiceeMgtKey String 24 조건부 공급받는자 문서번호
문서 관리를 위해 파트너가 할당하는 고유 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
invoiceeType String - Y 공급받는자 구분 (택 1)
사업자
개인
외국인
invoiceeCorpNum String 13 Y 공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우, 사업자번호
- {invoiceeType}="개인" 경우, 주민등록번호
- {invoiceeType}="외국인" 경우, "9999999999999"
invoiceeTaxRegID String 4 N 공급받는자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoiceeCorpName String 200 Y 공급받는자 상호
invoiceeCEOName String 100 Y 공급받는자 대표자 성명
invoiceeAddr String 300 N 공급받는자 주소
invoiceeBizType String 100 N 공급받는자 업태
invoiceeBizClass String 100 N 공급받는자 종목
invoiceeContactName1 String 100 N 공급받는자 담당자 성명
invoiceeDeptName1 String 100 N 공급받는자 담당자 부서명
invoiceeTEL1 String 20 N 공급받는자 담당자 연락처
invoiceeHP1 String 20 N 공급받는자 담당자 휴대폰
invoiceeEmail1 String 100 N 공급받는자 담당자 이메일
invoiceeSMSSendYN Boolean - N 공급받는자 알림문자 전송 여부
true전송
false미전송 : 기본값
수신자 : 공급자 휴대폰번호 {invoicerHP}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
trusteeMgtKey String 24 조건부 수탁자 문서번호
문서 관리를 위해 파트너가 할당하는 고유 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
trusteeCorpNum String 10 조건부 수탁자 사업자번호 ('-' 제외)
trusteeTaxRegID String 4 N 수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
trusteeCorpName String 200 조건부 수탁자 상호
trusteeCEOName String 100 조건부 수탁자 대표자 성명
trusteeAddr String 300 N 수탁자 주소
trusteeBizType String 100 N 수탁자 업태
trusteeBizClass String 100 N 수탁자 종목
trusteeContactName String 100 N 수탁자 담당자 성명
trusteeDeptName String 100 N 수탁자 담당자 부서명
trusteeTEL String 20 N 수탁자 담당자 연락처
trusteeHP String 20 N 수탁자 담당자 휴대폰
trusteeEmail String 100 N 수탁자 담당자 이메일
trusteeSMSSendYN Boolean - N 수탁자 알림문자 전송여부
true전송
false미전송 : 기본값
수신자 : 공급받는자 휴대폰번호 {invoiceeHP1}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
modifyCode Short 1 조건부 수정 사유코드
수정세금계산서 작성시 필수
[참고] 수정세금계산서
orgNTSConfirmNum String 24 조건부 원본 세금계산서 국세청 승인번호
수정세금계산서 작성시 필수
businessLicenseYN Boolean - N 팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
bankBookYN Boolean - N 팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
detailList List<TaxinvoiceDetail> N 품목 상세정보
최대 : 99건
addContactList List<TaxinvoiceAddContact> N 공급받는자 추가담당자 정보
여러 담당자에게 발행 안내 메일을 보내야할 경우 사용
최대 : 5명

Taxinvoice - 출력부

순번 변수명 타입 길이 비고
ntsconfirmNum String 24 국세청 승인번호
세금계산서 발행(전자서명) 시점에 팝빌에서 자동으로 부여
issueType String 3 발행형태
정발행
역발행
위수탁
taxType String 2 과세형태
과세
영세
면세
chargeDirection String 3 과금방향
정과금 공급자 과금
역과금 공급받는자 과금
serialNum String 30 일련번호
kwon Short 4 책번호 "권" 항목
ho Short 4 책번호 "호" 항목
writeDate String 8 작성일자
형식 : yyyyMMdd
purposeType String 2 결제대금 수취여부
영수
청구
없음
supplyCostTotal String 18 공급가액 합계
정수만 입력 가능(소수점 자동 절사)
taxTotal String 18 세액 합계
정수만 입력 가능(소수점 자동 절사)
totalAmount String 18 합계금액
정수만 입력 가능(소수점 자동 절사)
cash String 18 현금
chkBill String 18 수표
credit String 18 외상
note String 18 어음
remark1 String 150 비고1
remark2 String 150 비고2
remark3 String 150 비고3
invoicerMgtKey String 24 공급자 문서번호
문서 관리를 위해 파트너가 할당하는 고유 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
invoicerCorpNum String 10 공급자 사업자번호 ('-' 제외)
invoicerTaxRegID String 4 공급자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoicerCorpName String 200 공급자 상호
invoicerCEOName String 100 공급자 대표자 성명
invoicerAddr String 300 공급자 주소
invoicerBizType String 100 공급자 업태
invoicerBizClass String 100 공급자 종목
invoicerContactName String 100 공급자 담당자 성명
invoicerDeptName String 100 공급자 담당자 부서명
invoicerTEL String 20 공급자 담당자 연락처
invoicerHP String 20 공급자 담당자 휴대폰
invoicerEmail String 100 공급자 담당자 이메일
invoicerSMSSendYN Boolean - 공급자 알림문자 전송 여부
true전송
false미전송
수신자 : 공급받는자 휴대폰번호 {invoiceeHP1}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
invoiceeMgtKey String 24 공급받는자 문서번호
문서 관리를 위해 파트너가 할당하는 고유 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
invoiceeType String 3 공급받는자 구분
사업자
개인
외국인
invoiceeCorpNum String 13 공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우, 사업자번호
- {invoiceeType}="개인" 경우, 주민등록번호
- {invoiceeType}="외국인" 경우, "9999999999999"
invoiceeTaxRegID String 4 공급받는자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
invoiceeCorpName String 200 공급받는자 상호
invoiceeCEOName String 100 공급받는자 대표자 성명
invoiceeAddr String 300 공급받는자 주소
invoiceeBizType String 100 공급받는자 업태
invoiceeBizClass String 100 공급받는자 종목
closeDownState Integer 1 공급받는자 휴폐업상태
  • null미확인
  • 0미등록
  • 1사업중
  • 2폐업
  • 3휴업
  • 4확인실패
세금계산서 발행시 팝빌에서 휴폐업조회 하여 결과값 반환
closeDownStateDate String 8 공급받는자 휴폐업일자
형식 : yyyyMMdd
invoiceeContactName1 String 100 공급받는자 담당자 성명
invoiceeDeptName1 String 100 공급받는자 담당자 부서명
invoiceeTEL1 String 20 공급받는자 담당자 연락처
invoiceeHP1 String 20 공급받는자 담당자 휴대폰
invoiceeEmail1 String 100 공급받는자 담당자 이메일
invoiceeSMSSendYN Boolean - 공급받는자 알림문자 전송 여부
true전송
false미전송
수신자 : 공급자 휴대폰번호 {invoicerHP}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
trusteeMgtKey String 24 수탁자 문서번호
수탁자의 문서 관리를 위해 파트너가 부여하는 식별번호
영문 대소문자, 숫자, 특수문자('-', '_')만 입력 가능
trusteeCorpNum String 10 수탁자 사업자번호
하이픈('-') 제외 10자리 숫자값
trusteeTaxRegID String 4 수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
trusteeCorpName String 200 수탁자 상호
trusteeCEOName String 100 수탁자 대표자 성명
trusteeAddr String 300 수탁자 주소
trusteeBizType String 100 수탁자 업태
trusteeBizClass String 100 수탁자 종목
trusteeContactName String 100 수탁자 담당자 성명
trusteeDeptName String 100 수탁자 담당자 부서명
trusteeTEL String 20 수탁자 담당자 연락처
trusteeHP String 20 수탁자 담당자 휴대폰
trusteeEmail String 100 수탁자 담당자 이메일
trusteeSMSSendYN Boolean - 수탁자 알림문자 전송여부
true전송
false미전송
수신자 : 공급받는자 휴대폰번호 {invoiceeHP1}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
modifyCode Short 1 수정 사유코드
수정세금계산서 작성시 반환 [참고] 수정세금계산서
orgNTSConfirmNum String 24 원본 세금계산서 국세청 승인번호
수정세금계산서 작성시 반환
businessLicenseYN Boolean - 팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
bankBookYN Boolean - 팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
detailList List<TaxinvoiceDetail> 품목 상세정보
최대 : 99건
addContactList List<TaxinvoiceAddContact> 공급받는자 추가담당자 정보
여러 담당자에게 발행 안내 메일을 보내야할 경우 사용
최대 : 5명

TaxinvoiceDetail

순번 변수명 타입 길이 필수 비고
serialNum Short 2 Y 일련번호
1부터 순차적으로 입력
최대 : 99
purchaseDT String 8 N 거래일자
형식 : yyyyMMdd
itemName String 100 N 품명
spec String 60 N 규격
qty String 12 N 수량
-99999999.99 ~ 999999999.99
소수점 아래 2번째 자리까지 입력 가능
unitCost String 18 N 단가
-99999999999999.99 ~ 999999999999999.99
소수점 아래 2번째 자리까지 입력 가능
supplyCost String 18 N 공급가액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 자동 절사
tax String 18 N 세액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 자동 절사
remark String 100 N 비고

TaxinvoiceXML

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
retObject String - 전자세금계산서 XML 문서

TaxinvoiceAddContact

순번 변수명 타입 길이 필수 비고
serialNum int 1 Y 일련번호
1부터 순차적으로 입력
최대 : 5
contactName String 100 N 담당자 성명
email String 100 Y 이메일

BulkResponse

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
message String - API 처리에 대한 응답메시지
receiptID String 24 접수아이디
접수 시점에 팝빌에서 자동으로 부여

BulkTaxinvoiceResult

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
submitID String 36 접수 시점에 고객사에서 부여한 제출아이디
submitCount long - 세금계산서 접수 건수
successCount long - 세금계산서 발행 성공 건수
failCount long - 세금계산서 발행 실패 건수
txState long 1 접수상태
0접수
1처리중
2처리완료
txResultCode long - 접수 결과코드
txStartDT String 14 발행처리 시작일시
형식 : yyyyMMddHHmmss
txEndDT String 14 발행처리 완료일시
형식 : yyyyMMddHHmmss
receiptDT String 14 접수일시
형식 : yyyyMMddHHmmss
issueResult List<BulkTaxinvoiceIssueResult> 발행결과
최대 : 100건
receiptID String 36 접수아이디
접수 시점에 팝빌에서 자동으로 부여

BulkTaxinvoiceIssueResult

순번 변수명 타입 길이 비고
invoicerMgtKey String 24 공급자 문서번호
공급자의 문서 관리를 위해 파트너가 할당한 식별번호
trusteeMgtKey String 24 수탁자 문서번호
파트너가 할당한 문서번호
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
ntsconfirmNum String 24 국세청 승인번호
세금계산서 발행 시점에 팝빌에서 자동으로 부여
issueDT String 14 발행일시
형식 : yyyyMMddHHmmss

TISearchResult

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
total String - 총 검색결과 건수
perPage String - 페이지당 검색개수
pageNum String - 페이지 번호
pageCount String - 페이지 개수
list List<TaxinvoiceInfo> 세금계산서 상태/요약정보
함수 [GetInfo – 상태 확인]의 리턴값 구성과 동일
최대 : 1,000건

TaxinvoiceInfo

순번 변수명 타입 길이 비고
itemKey String 18 팝빌에서 세금계산서 관리 목적으로 할당한 식별번호
taxType String 2 과세형태
과세
영세
면세
writeDate String 8 작성일자
형식 : yyyyMMdd
regDT String 14 임시저장 일시
형식 : yyyyMMddHHmmss
issueType String 3 발행형태
정발행
역발행
위수탁
supplyCostTotal String 18 공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
taxTotal String 18 세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
purposeType String 2 영수/청구
영수
청구
없음
issueDT String 14 발행일시
형식 : yyyyMMddHHmmss
lateIssueYN String - 지연발행 여부
true지연발행
false정상발행
openYN boolean - 개봉 여부
true
false
{issueType}="정발행" or "위수탁" 경우, 공급받는자가 세금계산서 보기 버튼을 클릭한 경우 개봉 처리
{issueType}="역발행" 경우, 공급자가 세금계산서 보기 버튼을 클릭한 경우 개봉 처리
openDT String 14 개봉일시
형식 : yyyyMMddHHmmss
stateMemo String 200 상태메모
stateCode Integer 3 상태코드
stateDT String 14 상태 변경일시
형식 : yyyyMMddHHmmss
ntsconfirmNum String 24 국세청 승인번호
세금계산서 발행 시점에 팝빌에서 자동으로 부여
ntsresult String 6 국세청 전송결과
ntssendDT String 14 국세청 전송일시
형식 : yyyyMMddHHmmss
ntsresultDT String 14 국세청 결과 수신일시
형식 : yyyyMMddHHmmss
ntssendErrCode String 6 결과코드
modifyCode Integer 1 수정세금계산서 발행시 입력한 사유코드
interOPYN boolean - 연동문서 여부
trueAPI를 통해 발행한 연동문서
false팝빌 사이트를 통해 발행한 문서
invoicerCorpName String 200 공급자 상호
invoicerCorpNum String 10 공급자 사업자번호
invoicerMgtKey String 24 공급자 문서번호
파트너가 팝빌에 세금계산서를 임시저장 또는 발행시 할당한 문서번호
invoicerPrintYN boolean - 공급자 인쇄여부
true
false
invoiceeCorpName String 200 공급받는자 상호
invoiceeCorpNum String 13 공급받는자 사업자번호
invoiceeMgtKey String 24 공급받는자 문서번호
파트너가 할당한 문서번호
invoiceePrintYN boolean - 공급받는자 인쇄여부
true
false
closeDownState Integer 1 공급받는자 휴폐업상태
  • null미확인
  • 0미등록
  • 1사업중
  • 2폐업
  • 3휴업
  • 4확인실패
closeDownStateDate String 8 공급받는자 휴폐업일자
형식 : yyyyMMdd
trusteeCorpName String 200 수탁자 상호
trusteeCorpNum String 10 수탁자 사업자번호
trusteeMgtKey String 24 수탁자 문서번호
파트너가 할당한 문서번호
trusteePrintYN boolean - 수탁자 인쇄여부
true
false

TaxinvoiceLog

순번 변수명 타입 길이 비고
docLogType Integer 3 로그타입
  • 100임시저장
  • 101수정
  • 102개봉
  • 103수신확인
  • 111메일 재전송
  • 112문자 재전송
  • 113팩스 재전송
  • 122문자 전송결과
  • 123팩스 전송결과
  • 124휴폐업 확인
  • 125문서번호 할당
  • 220역발행요청
  • 221역발행요청 거부
  • 222역발행요청 취소
  • 230발행
  • 240발행취소
  • 250국세청전송 요청
  • 251국세청전송 대기중
  • 252국세청전송 진행중
  • 253국세청전송 접수
  • 254국세청전송 성공
  • 255국세청전송 실패
log String 2000 이력정보
procType String 3 처리형태
연동API를 통해 처리함
일반팝빌 사이트를 통해 처리함
시스템팝빌이 처리함
procCorpName String 70 처리회사명
procContactName String 30 처리담당자
procMemo String 200 처리메모
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
ip String 39 아이피

AttachedFile

순번 변수명 타입 길이 비고
serialNum Integer 1 첨부파일 일련번호
attachedFile String 255 파일아이디
팝빌이 첨부파일 관리를 위해 할당한 식별번호
함수 [DeleteFile – 첨부파일 삭제]호출을 위한 필수값
displayName String 255 첨부파일명
regDT String 14 첨부일시

EmailSendConfig

순번 변수명 타입 길이 비고
emailType String 32 발송 메일 유형
정발행
TAX_ISSUE
공급받는자에게 세금계산서가 발행 되었음을 알려주는 메일
TAX_ISSUE_INVOICER
공급자에게 세금계산서가 발행 되었음을 알려주는 메일
TAX_CHECK
공급자에게 세금계산서가 수신확인 되었음을 알려주는 메일
TAX_CANCEL_ISSUE
공급받는자에게 세금계산서가 발행취소 되었음을 알려주는 메일
역발행
TAX_REQUEST
공급자에게 세금계산서를 전자서명 하여 발행을 요청하는 메일
TAX_CANCEL_REQUEST
공급받는자에게 세금계산서가 취소 되었음을 알려주는 메일
TAX_REFUSE
공급받는자에게 세금계산서가 거부 되었음을 알려주는 메일
위수탁 발행
TAX_TRUST_ISSUE
공급받는자에게 세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_ISSUE_TRUSTEE
수탁자에게 세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_ISSUE_INVOICER
공급자에게 세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_CANCEL_ISSUE
공급받는자에게 세금계산서가 발행취소 되었음을 알려주는 메일
TAX_TRUST_CANCEL_ISSUE_INVOICER
공급자에게 세금계산서가 발행취소 되었음을 알려주는 메일
처리결과
TAX_CLOSEDOWN
거래처의 휴폐업 여부를 확인하여 안내하는 메일
TAX_NTSFAIL_INVOICER
세금계산서 국세청 전송실패를 안내하는 메일
정기발송
ETC_CERT_EXPIRATION
팝빌에 등록된 인증서의 만료예정을 안내하는 메일
sendYN Boolean - 전송여부
true전송
false미전송

TaxinvoiceCertificate

순번 변수명 타입 길이 비고
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
인증서를 팝빌 인증서버에 등록한 시간
expireDT String 14 만료일시
형식 : yyyyMMddHHmmss
팝빌 인증서버에 등록된 인증서의 만료일시
issuerDN String 200 인증서 발급자 DN
subjectDN String 200 등록된 인증서 DN
issuerName String 12 인증서 종류
전자세금용 공동인증서
팝빌 특목용 공동인증서
기타
oid String 30 OID
regContactName String 100 등록 담당자 성명
팝빌 인증서버에 인증서를 등록한 담당자 성명
regContactID String 50 등록 담당자 아이디
팝빌 인증서버에 인증서를 등록한 담당자 팝빌회원 아이디

UseHistoryResult

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

RefundHistoryResult

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

RefundHistory

순번변수명타입길이비고
reqDT String 14 신청일시
형식 : yyyyMMddHHmmss
requestPoint String 18 환불 신청포인트
accountBank String 10 환불계좌 은행명
accountNum String 50 환불계좌번호
accountName String 70 환불계좌 예금주명
state int 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 Long - API 처리에 대한 응답코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
message String - API 처리에 대한 응답메시지
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자 이하
영문, 숫자, 특수문자 조합
담당자 추가시 필수
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사용중

EmailPublicKey

순번 변수명 타입 길이 비고
confirmNum String 8 유통사업자 승인번호
email String 40 유통사업자 이메일

RefundResponse

순번 변수명 타입 길이 비고
code Integer - API 처리에 대한 응답코드
- 성공 : 1
- 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드
message String - API 처리에 대한 응답메시지
refundCode String 18 환불코드