POPBill Developers
API Reference

A. 객체정보

Response

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

SMTIssueResponse

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

PopbillException

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

Statement - 입력부

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

Statement - 출력부

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

StatementDetail

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

StmtSearchResult

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

StatementInfo

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

StatementLog

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

AttachedFile

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

EmailSendConfig

순번변수명타입길이설명
emailType str 9 전송 메일 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
sendYN bool - 메일 전송 여부
True전송
False미전송