정액제 신청 / 포인트 관리

1. GetFlatRateState - 정액제 서비스 상태 확인

홈택스수집 정액제 서비스 상태를 확인합니다.

HTFlatRate GetFlatRateState(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

HTFlatRate

순번	변수명	타입	길이	설명
1	referenceID	String	10	사업자번호 ('-' 제외)
2	contractDT	String	14	정액제 서비스 시작일시 → 형식 : yyyyMMddHHmmss
3	useEndDate	String	8	정액제 서비스 만료일자 → 형식 : yyyyMMdd
4	baseDate	int?	2	자동연장 결제일 5 15 25
5	state	int?	1	정액제 서비스 상태 1 사용 또는 사용제한 2 해지
6	closeRequestYN	bool?	-	정액제 서비스 해지신청 여부 true 신청 false 미신청
7	useRestrictYN	bool?	-	정액제 서비스 사용제한 여부 true 사용제한 false 사용
8	closeOnExpired	bool?	-	정액제 서비스 해지 구분 true 일반해지 (정액제 서비스 만료일 해지) false 중도해지 (요청 즉시 해지)
9	unPaidYN	bool?	-	미수금 보유 여부 true 보유 false 미보유

예외

PopbillException

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

2. GetFlatRatePopUpURL - 정액제 신청 팝업 URL

미리보기

정액제를 신청하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

String GetFlatRatePopUpURL(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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

3. GetChargeInfo - 과금정보 확인

팝빌 홈택스수집 API 서비스 과금정보를 확인합니다.

ChargeInfo GetChargeInfo(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

ChargeInfo

순번	변수명	타입	길이	설명
1	unitCost	String	12	요금
2	chargeMethod	String	3	과금유형 연동 파트너
3	rateSystem	String	3	요금제도 정액제 종량제

예외

PopbillException

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

4. GetBalance - 연동회원 잔여포인트 확인

연동회원의 잔여포인트를 확인합니다.

Double GetBalance(String CorpNum)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)

응답

Double - 연동회원 잔여포인트

예외

PopbillException

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

5. GetChargeURL - 연동회원 포인트 충전 팝업 URL

미리보기

연동회원 포인트를 충전하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

String GetChargeURL(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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

6. GetUseHistory - 연동회원 포인트 사용내역 확인

• 연동회원의 포인트 사용내역을 확인합니다.

UseHistoryResult getUseHistory(String CorpNum, String SDate, String EDate, int? Page, int? PerPage, String Order, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SDate	String	8	Y	검색 시작일자 → 형식 : yyyyMMdd
3	EDate	String	8	Y	검색 종료일자 → 형식 : yyyyMMdd
4	Page	int?	-	N	목록 페이지번호 ※ 기본값 : 1
5	PerPage	int?	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
6	Order	String	1	N	거래일자를 기준으로 하는 목록 정렬 방향 D 내림차순 : 기본값 A 오름차순
7	UserID	String	50	N	팝빌회원 아이디

응답

UseHistoryResult

순번	변수명	타입	길이	설명
1	code	long	-	API 처리에 대한 응답코드 1 성공
2	total	long	-	총 검색결과 건수
3	perPage	long	-	페이지당 목록 건수
4	pageNum	long	-	페이지 번호
5	pageCount	long	-	페이지 개수
6	list	List<UseHistory>	-	사용내역
List<UseHistory> 순번 변수명 타입 길이 설명 1 itemCode String 3 서비스 코드 110 세금계산서 111 홈택스수집(세금) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증 140 현금영수증 141 홈택스수집(현금) 150 문자(SMS) 151 문자(LMS) 152 문자(MMS) 153 알림톡 160 팩스(일반망) 161 팩스(지능망) 170 사업자등록상태조회 171 기업정보조회 180 계좌조회 182 성명조회 183 실명조회 2 txType String 2 포인트 증감 유형 11 (포인트 증가) 포인트 충전 12 (포인트 증가) 조정 13 (포인트 증가) 조정 19 (포인트 증가) 분배 31 (포인트 증가) 환불 32 (포인트 증가) 정액제 해지 21 (포인트 감소) 서비스 사용 22 (포인트 감소) 조정 23 (포인트 감소) 조정 24 (포인트 감소) 포인트 결제 25 (포인트 감소) 미수금 결제 26 (포인트 감소) 포인트 환불 29 (포인트 감소) 회수 41 (포인트 감소) 후불누적조정 3 txPoint String 18 증감 포인트 4 balance String 18 잔여포인트 5 txDT String 14 포인트 증감 일시 → 형식 : yyyyMMddHHmmss 6 userID String 50 담당자 아이디 7 userName String 100 담당자명

예외

PopbillException

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

7. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL

미리보기

연동회원 포인트 사용내역 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

String GetUseHistoryURL(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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

8. PaymentRequest - 연동회원 무통장 입금신청

연동회원 포인트 충전을 위해 무통장입금을 신청합니다.

PaymentResponse paymentRequest(String CorpNum, PaymentForm PaymentForm, String UserID = null)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	PaymentForm	PaymentForm	-	Y	입금신청 객체정보
PaymentForm 순번 변수명 타입 길이 필수 설명 1 settlerName String 100 N 담당자명 2 settlerEmail String 100 N 담당자 메일 3 notifyHP String 20 N 담당자 휴대폰 → 무통장 입금 승인 알림톡이 전송될 번호 4 paymentName String 70 Y 입금자명 5 settleCost String 18 Y 결제금액
3	UserID	String	50	N	팝빌회원 아이디

응답

PaymentResponse

순번	변수명	타입	길이	설명
1	code	long	-	응답코드
2	message	String	-	응답메시지
3	settleCode	String	18	정산코드

예외

PopbillException

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

9. GetSettleResult - 연동회원 무통장 입금신청 정보확인

연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.

PaymentHistory getSettleResult(String CorpNum, String SettleCode, String UserID = null)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SettleCode	String	18	Y	정산코드 → 팝빌에서 임의 할당하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
3	UserID	String	50	N	팝빌회원 아이디

응답

PaymentHistory

순번	변수명	타입	길이	설명
1	productType	String	3	결제 내용 포인트 정액제 미수금
2	productName	String	30	결제 상품명
3	settleType	String	7	결제유형 무통장 신용카드 실시간계좌이체
4	settlerName	String	100	담당자명
5	settlerEmail	String	100	담당자메일
6	settleCost	String	18	결제금액
7	settlePoint	String	18	충전포인트
8	settleState	int	1	결제상태 1 대기 2 승인 3 실패 4 취소 5 취소
9	regDT	String	14	등록일시 → 형식 : yyyyMMddHHmmss
10	stateDT	String	14	상태일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

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

10. GetPaymentHistory - 연동회원 포인트 결제내역 확인

연동회원의 포인트 결제내역을 확인합니다.

PaymentHistoryResult getPaymentHistory(String CorpNum, String SDate, String EDate, int? Page = null, int? PerPage = null, String UserID = null)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SDate	String	8	Y	검색 시작일자 → 형식 : yyyyMMdd
3	EDate	String	8	Y	검색 종료일자 → 형식 : yyyyMMdd
4	Page	int?	-	N	목록 페이지번호 ※ 기본값 : 1
5	PerPage	int?	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
6	UserID	String	50	N	팝빌회원 아이디

응답

PaymentHistoryResult

순번	변수명	타입	길이	설명
1	code	long	-	API 처리에 대한 응답코드 1 성공
2	total	long	-	총 검색결과 건수
3	perPage	long	-	페이지당 목록 건수
4	pageNum	long	-	페이지 번호
5	pageCount	long	-	페이지 개수
6	list	List<PaymentHistory>	-	결제내역
List<PaymentHistory> 순번 변수명 타입 길이 설명 1 productType String 3 결제 내용 포인트 정액제 미수금 2 productName String 30 결제 상품명 3 settleType String 7 결제유형 무통장 신용카드 실시간계좌이체 4 settlerName String 100 담당자명 5 settlerEmail String 100 담당자메일 6 settleCost String 18 결제금액 7 settlePoint String 18 충전포인트 8 settleState int 1 결제상태 1 대기 2 승인 3 실패 4 취소 5 취소 9 regDT String 14 등록일시 → 형식 : yyyyMMddHHmmss 10 stateDT String 14 상태일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

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

11. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL

미리보기

연동회원 포인트 결제내역 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

String GetPaymentURL(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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

12. Refund - 연동회원 포인트 환불신청

연동회원 포인트를 환불 신청합니다.

RefundResponse refund(String CorpNum, RefundForm RefundForm, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	RefundForm	RefundForm	-	Y	환불신청 객체정보
RefundForm 순번 변수명 타입 길이 필수 설명 1 contactName String 100 Y 담당자명 2 tel String 20 Y 담당자 연락처 3 requestPoint String 18 Y 환불 신청 포인트 4 accountBank String 10 Y 은행명 5 accountNum String 50 Y 계좌번호 6 accountName String 70 Y 예금주명 7 reason String 200 N 환불사유
3	UserID	String	50	N	팝빌회원 아이디

응답

RefundResponse

순번	변수명	타입	길이	설명
1	code	long	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	refundCode	String	18	환불코드

예외

PopbillException

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

13. GetRefundHistory - 연동회원 포인트 환불내역 확인

연동회원의 포인트 환불신청내역을 확인합니다.

RefundHistoryResult getRefundHistory(String CorpNum, int? Page, int? PerPage, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	Page	int?	-	N	목록 페이지번호 ※ 기본값 : 1
3	PerPage	int?	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
4	UserID	String	50	N	팝빌회원 아이디

응답

RefundHistoryResult

순번	변수명	타입	길이	설명
1	code	long	-	API 처리에 대한 응답코드 1 성공
2	total	long	-	총 검색결과 건수
3	perPage	long	-	페이지당 목록 건수
4	pageNum	long	-	페이지 번호
5	pageCount	long	-	페이지 개수
6	list	List<RefundHistory>	-	환불내역
List<RefundHistory> 순번 변수명 타입 길이 설명 1 reqDT String 14 신청일시 → 형식 : yyyyMMddHHmmss 2 requestPoint String 18 환불 신청포인트 3 accountBank String 10 환불계좌 은행명 4 accountNum String 50 환불계좌번호 5 accountName String 70 환불계좌 예금주명 6 state int 1 상태 1 접수대기 2 심사중 3 입금대기 4 환불완료 5 취소 7 reason String 200 환불사유

예외

PopbillException

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

14. GetRefundInfo - 환불 신청 상태 조회

포인트 환불에 대한 상세정보 1건을 확인합니다.

RefundHistory GetRefundInfo(String CorpNum, String RefundCode, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	RefundCode	String	18	Y	환불코드
3	UserID	String	50	N	팝빌회원 아이디

응답

RefundHistory

순번	변수명	타입	길이	설명
1	reqDT	String	14	신청일시 → 형식 : yyyyMMddHHmmss
2	requestPoint	String	18	환불 신청포인트
3	accountBank	String	10	환불계좌 은행명
4	accountNum	String	50	환불계좌번호
5	accountName	String	70	환불계좌 예금주명
6	state	int	1	상태 1 접수대기 2 심사중 3 입금대기 4 환불완료 5 취소
7	reason	String	200	환불사유

예외

PopbillException

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

15. GetRefundableBalance - 환불 가능 포인트 조회

환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불 가능 포인트에서 제외됩니다.)

Double GetRefundableBalance(String CorpNum, String UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디

응답

Double - 환불 가능 포인트

예외

PopbillException

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

16. GetPartnerBalance - 파트너 잔여포인트 확인

파트너의 잔여포인트를 확인합니다.

Double GetPartnerBalance(String CorpNum)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)

응답

Double - 파트너 잔여포인트

예외

PopbillException

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

17. GetPartnerURL - 파트너 포인트 충전 팝업 URL

미리보기

파트너 포인트를 충전하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

String GetPartnerURL(String CorpNum, String TOGO)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	TOGO	String	4	Y	고정값 : "CHRG"

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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