POPBill Developers
가이드

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

API Reference

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

SDK

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

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

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

API Reference
전자명세서
Ruby
API Reference 전자명세서 Ruby 객체정보

A. 객체정보

Response

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

IssueResponse

순번변수명타입길이설명
code Integer - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
invoiceNum String 24 팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당

PopbillException

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

Statement - 입력부

순번변수명타입길이필수설명
itemCode Integer 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
mgtKey String 24 Y 문서번호
전자명세서 관리를 위해 파트너가 할당하는 식별번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
formCode String 8 N 맞춤양식 코드
기본값 : 팝빌에서 설정한 기본양식 사용
writeDate String 8 Y 작성일자
형식 : yyyyMMdd
taxType String 2 조건부 과세형태 (택 1)
과세
영세
면세
{itemCode}=121 경우 필수
purposeType String 2 Y 영수/청구 (택 1)
영수
청구
없음
serialNum String 30 N 일련번호
taxTotal String 18 Y 세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
supplyCostTotal String 18 Y 공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
totalAmount String 18 N 합계금액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
remark1 String 150 N 비고 1
remark2 String 150 N 비고 2
remark3 String 150 N 비고 3
senderCorpNum String 10 Y 발신자 사업자번호 ('-' 제외)
senderTaxRegID String 4 N 발신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
senderCorpName String 200 N 발신자 상호
senderCEOName String 100 N 발신자 대표자성명
senderAddr String 300 N 발신자 주소
senderBizType String 100 N 발신자 업태
senderBizClass String 100 N 발신자 종목
senderContactName String 100 N 발신자 성명
senderDeptName String 40 N 발신자 부서명
senderTEL String 20 N 발신자 연락처
senderHP String 20 N 발신자 휴대전화
senderEmail String 100 N 발신자 이메일주소
senderFAX String 20 N 발신자 팩스번호
receiverCorpNum String 10 Y 수신자 사업자번호 ('-' 제외)
receiverTaxRegID String 4 N 수신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
receiverCorpName String 200 Y 수신자 상호
receiverCEOName String 100 N 수신자 대표자성명
receiverAddr String 300 N 수신자 주소
receiverBizType String 100 N 수신자 업태
receiverBizClass String 100 N 수신자 종목
receiverContactName String 100 Y 수신자 성명
receiverDeptName String 40 N 수신자 부서명
receiverTEL String 20 N 수신자 연락처
receiverHP String 20 N 수신자 휴대전화
receiverEmail String 100 N 수신자 이메일주소
receiverFAX String 20 N 수신자 팩스번호
propertyBag Hash - N 추가속성
전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력 [참고] 기본양식 추가속성
businessLicenseYN Boolean - N 팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
bankBookYN Boolean - N 팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
smssendYN Boolean - N 알림문자 전송 여부
true전송
false미전송 : 기본값
수신자 : 수신자 휴대폰번호 {receiverHP}
문자 전송 포인트가 차감(단, 전송실패 건은 환불)
detailList StatementDetail[ ] N 거래 물품 상세 정보
길이 제한 없음

Statement - 출력부

순번변수명타입길이설명
itemCode Integer 3 전자명세서 문서유형
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
mgtKey String 24 문서번호
전자명세서 관리를 위해 파트너가 할당하는 식별번호
invoiceNum String 24 팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당
formCode String 8 맞춤양식 코드
writeDate String 8 작성일자
형식 : yyyyMMdd
taxType String 2 과세형태
과세
영세
면세
{itemCode}=121 경우 반환
purposeType String 2 영수/청구
영수
청구
없음
serialNum String 30 일련번호
taxTotal String 18 세액 합계
supplyCostTotal String 18 공급가액 합계
totalAmount String 18 합계금액
remark1 String 150 비고 1
remark2 String 150 비고 2
remark3 String 150 비고 3
senderCorpNum String 10 발신자 사업자번호 ('-' 제외)
senderTaxRegID String 4 발신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
senderCorpName String 200 발신자 상호
senderCEOName String 100 발신자 대표자성명
senderAddr String 300 발신자 주소
senderBizType String 100 발신자 업태
senderBizClass String 100 발신자 종목
senderContactName String 100 발신자 성명
senderDeptName String 40 발신자 부서명
senderTEL String 20 발신자 연락처
senderHP String 20 발신자 휴대전화
senderEmail String 100 발신자 이메일주소
senderFAX String 20 발신자 팩스번호
receiverCorpNum String 10 수신자 사업자번호 ('-' 제외)
receiverTaxRegID String 4 수신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
receiverCorpName String 200 수신자 상호
receiverCEOName String 100 수신자 대표자성명
receiverAddr String 300 수신자 주소
receiverBizType String 100 수신자 업태
receiverBizClass String 100 수신자 종목
receiverContactName String 100 수신자 성명
receiverDeptName String 40 수신자 부서명
receiverTEL String 20 수신자 연락처
receiverHP String 20 수신자 휴대전화
receiverEmail String 100 수신자 이메일주소
receiverFAX String 20 수신자 팩스번호
propertyBag Hash - 추가속성
전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력 [참고] 기본양식 추가속성
businessLicenseYN Boolean - 팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부
bankBookYN Boolean - 팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부
smssendYN Boolean - 알림문자 전송 여부
true전송
false미전송
수신자 : 수신자 휴대폰번호 {receiverHP}
detailList StatementDetail[ ] 거래 물품 상세 정보
길이 제한 없음

StatementDetail

순번변수명타입길이필수설명
serialNum Integer - Y 일련번호
1부터 순차적으로 입력
purchaseDT String 8 N 거래일자
형식 : yyyyMMdd
itemName String 100 N 품명
spec String 60 N 규격
qty String 12 N 수량
소수점 아래 2번째 자리까지 입력 가능
unitCost String 18 N 단가
소수점 아래 2번째 자리까지 입력 가능
마이너스 금액 입력 가능
supplyCost String 18 N 공급가액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
tax String 18 N 세액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
remark String 100 N 비고
spare1 String 100 N 여분1
spare2 String 100 N 여분2
spare3 String 100 N 여분3
spare4 String 100 N 여분4
spare5 String 100 N 여분5
spare6 String 100 N 여분6
spare7 String 100 N 여분7
spare8 String 100 N 여분8
spare9 String 100 N 여분9
spare10 String 100 N 여분10
spare11 String 100 N 여분11
spare12 String 100 N 여분12
spare13 String 100 N 여분13
spare14 String 100 N 여분14
spare15 String 100 N 여분15
spare16 String 100 N 여분16
spare17 String 100 N 여분17
spare18 String 100 N 여분18
spare19 String 100 N 여분19
spare20 String 100 N 여분20

StmtSearchResult

순번변수명타입길이설명
code Integer - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 목록 건수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
list StatementInfo[ ] 전자명세서 상태/요약정보
함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일
최대 1,000건

StatementInfo

순번변수명타입길이설명
itemCode Integer 3 전자명세서 문서유형
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
itemKey String 18 팝빌번호
팝빌에서 전자명세서 관리 목적으로 할당한 식별번호
invoiceNum String 24 팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당
mgtKey String 24 파트너가 할당한 문서번호
taxType String 2 과세형태
과세
영세
면세
writeDate String 8 작성일자
형식 : yyyyMMdd
regDT String 14 임시저장일시
형식 : yyyyMMddHHmmss
senderCorpName String 200 발신자 상호
senderCorpNum String 10 발신자 사업자번호
senderPrintYN Boolean - 발신자 인쇄여부
true인쇄
false미인쇄
receiverCorpName String 200 수신자 상호
receiverCorpNum String 10 수신자 사업자번호
receiverPrintYN Boolean - 수신자 인쇄여부
true인쇄
false미인쇄
supplyCostTotal String 18 공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
taxTotal String 18 세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사
purposeType String 2 영수/청구
영수
청구
없음
issueDT String 14 발행일시
형식 : yyyyMMddHHmmss
stateCode Integer 3 상태코드
[참고] 팝빌 상태코드
stateDT String 14 상태 변경일시
형식 : yyyyMMddHHmmss
stateMemo String 200 상태메모
openYN Boolean - 개봉여부
true개봉
false미개봉
openDT String 14 개봉 일시
형식 : yyyyMMddHHmmss

StatementLog

순번변수명타입길이설명
docLogType Integer 3 로그타입
  • 100임시저장
  • 101수정
  • 102개봉
  • 103수신확인
  • 111메일 재전송
  • 112문자 재전송
  • 113팩스 재전송
  • 122문자 전송결과
  • 123팩스 전송결과
  • 310발행
  • 312자동승인
  • 340발행취소
log String 2000 이력정보
procType String 3 처리형태
연동API를 통해 처리함
일반팝빌 사이트를 통해 처리함
시스템팝빌이 처리함
procMemo String 200 처리메모
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
ip String 39 아이피

AttachedFile

순번변수명타입길이설명
serialNum Integer 1 첨부파일 일련번호
attachedFile String 255 첨부파일 삭제시 사용
displayName String 255 첨부파일명
regDT String 14 첨부일시
형식 : yyyyMMddHHmmss

EmailSendConfig

순번변수명타입길이설명
emailType String 9 전송 메일 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
sendYN 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 사업자번호 ('-' 제외)
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 String 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사용중