객체정보｜전자명세서｜POPBiLL Developers

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	Y	수신자 사업자번호 ('-' 제외)
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	Y	수신자 성명
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	로그타입
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미전송

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	12	발행단가
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	환불코드

A. 객체정보

Response

SMTIssueResponse

PopbillException

Statement - 입력부

Statement - 출력부

StatementDetail

StmtSearchResult

StatementInfo

StatementLog

AttachedFile

EmailSendConfig

UseHistoryResult

UseHistory

PaymentHistoryResult

PaymentHistory

RefundHistoryResult

RefundHistory

RefundForm

PaymentForm

PaymentResponse

ChargeInfo

JoinForm

CorpInfo

ContactInfo - 입력부

ContactInfo - 출력부

RefundResponse