객체정보｜팩스｜POPBiLL Developers

Response

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

PopbillException

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

SenderNumber

변수명	타입	길이	설명
number	str	20	발신번호
representYN	bool	-	대표번호 지정여부 True대표번호 False일반번호
state	int	1	등록상태 0대기 1승인 2취소
memo	str	200	메모

FaxReceiver

변수명	타입	길이	필수	설명
receiveNum	str	20	Y	팩스 단말기 번호 또는 인터넷 팩스 번호
receiveName	str	30	N	수신자명
interOPRefKey	str	20	N	파트너 지정키 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

FileData

순번	변수명	타입	길이	필수	설명
	fileName	str	-	Y	팩스로 전송할 파일명
	fileData	bytes	-	Y	팩스로 전송할 파일의 바이너리 데이터

FAXSearchResult

변수명	타입	길이	설명
code	int	-	API 처리에 대한 응답코드 1성공
message	str	-	API 처리에 대한 응답메시지
total	str	-	총 검색결과 건수
perPage	str	-	페이지당 목록 건수
pageNum	str	-	페이지 번호
pageCount	str	-	페이지 개수
list	List<FaxResult>		전송결과 정보 최대 : 1,000건

FaxResult

변수명	타입	길이	설명
state	int	1	상태코드 [참고] 팝빌 상태코드
result	int	3	결과코드 {state} = 3 경우 팩스 전송결과 확인 가능 [참고] 통신사 결과코드
sendNum	str	20	발신번호
senderName	str	30	발신자명
receiveNum	str	20	수신번호
receiveNumType	str	2	수신번호 유형 일반일반망 (지능망을 제외한 번호) 지능지능망 (030, 050, 070, 080, 대표번호)
receiveName	str	30	수신자명
title	str	100	팩스제목
sendPageCnt	int	-	전체 페이지수
successPageCnt	int	-	성공 페이지수
failPageCnt	int	-	실패 페이지수
cancelPageCnt	int	-	취소 페이지수
reserveDT	str	14	예약일시 형식 : yyyyMMddHHmmss
receiptDT	str	14	접수일시 형식 : yyyyMMddHHmmss
sendDT	str	14	전송일시 형식 : yyyyMMddHHmmss
resultDT	str	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
fileNames	str[ ]	20	전송 파일명 리스트
receiptNum	str	18	팩스 전송요청시 팝빌로부터 반환 받은 접수번호
requestNum	str	36	팩스 전송요청시 파트너가 할당한 요청번호
interOPRefKey	str	20	파트너 지정키 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
chargePageCnt	int	-	과금 페이지수
refundPageCnt	int	-	환불 페이지수
tiffFileSize	str	-	변환파일용량 단위 : byte

UseHistoryResult

변수명	타입	길이	설명
code	int	-	API 처리에 대한 응답코드 1성공
total	int	-	총 검색결과 건수
perPage	int	-	페이지당 목록 건수
pageNum	int	-	페이지 번호
pageCount	int	-	페이지 개수
list	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	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	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

PopbillException

SenderNumber

FaxReceiver

FileData

FAXSearchResult

FaxResult

UseHistoryResult

UseHistory

PaymentHistoryResult

PaymentHistory

RefundHistoryResult

RefundHistory

RefundForm

PaymentForm

PaymentResponse

ChargeInfo

JoinForm

CorpInfo

ContactInfo - 입력부

ContactInfo - 출력부

RefundResponse