정액제 신청 / 포인트 관리

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

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

def getFlatRateState(corpNum, userID = "")

요청

Parameters

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

응답

THometaxTIFlatRate

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

예외

EPopbillException

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

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

미리보기

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

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

function GetFlatRatePopUpURL(CorpNum : String; UserID : String = '') : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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

3. GetChargeInfo - 과금정보 확인

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

function GetChargeInfo(CorpNum : String; UserID: String) : THTTaxinvoiceChargeInfo;

요청

Parameters

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

응답

THTTaxinvoiceChargeInfo

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

예외

EPopbillException

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

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

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

function GetBalance(CorpNum : String) : Double;

요청

Parameters

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

응답

Double - 연동회원 잔여포인트

예외

EPopbillException

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

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

미리보기

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

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

function GetChargeURL(CorpNum : String; UserID : String) : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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

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

미리보기

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

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

function GetPaymentURL(CorpNum : String; UserID : String) : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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

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

미리보기

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

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

function GetUseHistoryURL(CorpNum : String; UserID : String) : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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

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

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

function GetPartnerBalance(CorpNum : String) : Double;

요청

Parameters

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

응답

Double - 파트너 잔여포인트

예외

EPopbillException

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

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

미리보기

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

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

function GetPartnerURL(CorpNum : String; TOGO : String) : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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