1. 휴폐업조회

1.1. CheckCorpNum - 단건 조회

ㆍ사업자번호 1건에 대한 휴폐업정보를 확인합니다.

Function CheckCorpNum(MemberCorpNum As String, CorpNum As String) As PBCorpState

Parameters

순번 변수명 타입 길이 필수 설명
1 MemberCorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpNum String - O 조회할 사업자번호

Return

PBCorpState

Throws

Err

1.2. CheckCorpNums - 대량 조회

ㆍ다수건의 사업자번호에 대한 휴폐업정보를 확인합니다. (최대 1,000건)

Function CheckCorpNums(MemberCorpNum As String, CorpNumList As Collection) As Collection

Parameters

순번 변수명 타입 길이 필수 설명
1 MemberCorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpNumList Collection 1000 O [배열] 조회할 사업자번호 (최대 1,000건)

Return

PBCorpState[ ]

Throws

Err

2. 포인트 관리

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

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

Function GetBalance(CorpNum As String) As Double

Parameters

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

Return

Double - 연동회원 잔여포인트

Throws

Err

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

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

Function GetChargeURL(CorpNum As String, UserID As String) As String

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

Function GetPartnerBalance(CorpNum As String) As Double

Parameters

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

Return

Double - 파트너 잔여포인트

Throws

Err

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

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

Function GetPartnerURL(CorpNum As String, TOGO As String) As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO String - O "CHRG" 입력

Return

String - 요청에 대한 응답 URL

Throws

Err

2.5. GetUnitCost - 조회 단가 확인

ㆍ휴폐업 조회시 과금되는 포인트 단가를 확인합니다.

Function GetUnitCost(CorpNum As String) As Double

Parameters

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

Return

Double - 휴폐업조회 단가

Throws

Err

2.6. GetChargeInfo - 과금정보 확인

ㆍ팝빌 휴폐업조회 API 서비스 과금정보를 확인합니다.

Function GetChargeInfo(CorpNum As String, Optional UserID As String = "") As PBChargeInfo

Parameters

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

Return

PBChargeInfo

Throws

Err

3. 회원정보

3.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

Function CheckIsMember(CorpNum As String, LinkID As String) As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

PBResponse

Throws

Err

3.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

Function CheckID(IDString As String) As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 IDString String 20 O 중복여부를 확인할 아이디

Return

PBResponse - code : 0 (미사용중) / code : 1 (사용중)

Throws

Err

3.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

Function JoinMember(JoinInfo As PBJoinForm) As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo PBJoinForm - O 연동회원 객체정보

Return

PBResponse

Throws

Err

3.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

Function GetAccessURL(CorpNum As String, UserID As String) As String

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

3.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

Function GetCorpInfo(CorpNum As String, Optional UserID As String = "") As PBCorpInfo

Parameters

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

Return

PBCorpInfo

Throws

Err

3.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

Function UpdateCorpInfo(CorpNum As String, CorpInfo As PBCorpInfo, Optional UserID As String = "") As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo PBCorpInfo - O 회사 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

3.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

Function RegistContact(CorpNum As String, ContactInfo As PBContactInfo, Optional UserID As String = "") As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo PBContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

3.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

Function ListContact(CorpNum As String, Optional UserID As String = "") As Collection

Parameters

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

Return

PBContactInfo[ ]

Throws

Err

3.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

Function UpdateContact(CorpNum As String, ContactInfo As PBContactInfo, UserID As String) As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo PBContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

A. 객체정보

A.1. PBResponse

순번 변수명 항목명 타입 길이 비고
1 code 코드 Long - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지

A.2. Err (Property)

순번 변수명 항목명 타입 길이 비고
1 LastErrCode 코드 Long - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
[참고] 오류코드
2 LastErrMessage 메시지 String - API 처리 실패에 대한 오류메시지

A.3. PBCorpState

순번 변수명 항목명 타입 길이 비고
1 corpNum 사업자번호 String - 조회한 사업자번호
2 ctype 사업자 과세유형 String - null : (미확인) / "1" : (일반과세자) / "2" : (면세과세자)
"3" : (간이과세자) / "4" : (비영리법인 또는 국가기관, 고유번호가 부여된 단체) 중 반환
3 typeDate 과세유형 전환일자 String - 형식 : yyyy-MM-dd
4 state 휴폐업상태 String - null : (미확인) / "0" : (미등록 - 등록되지 않은 사업자번호) / "1" : (사업중) / "2" : (폐업) / "3" : (휴업) 중 반환
5 stateDate 휴폐업일자 String - 형식 : yyyy-MM-dd
6 checkDate 국세청 확인일자 String - 팝빌이 휴폐업 조회한 일자 (형식 : yyyy-MM-dd)

A.4. PBChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 조회단가 String -
2 chargeMethod 과금유형 String - "연동" / "파트너" 중 반환
3 rateSystem 과금제도 String - "종량제" 반환

A.5. PBJoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 미만
2 PWD 비밀번호 String 20 O 6자 이상 20자 미만
3 LinkID 파트너 링크아이디 String 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 String 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 String 100 O
6 CorpName 회사명 String 200 O
7 Addr 사업장 주소 String 300 O
8 BizType 업태 String 100 O
9 BizClass 종목 String 100 O
10 ContactName 담당자 성명 String 100 O
11 ContactEmail 담당자 이메일 String 100 O
12 ContactTEL 담당자 연락처(전화번호) String 20 O
13 ContactHP 담당자 휴대폰번호 String 20 -
14 ContactFAX 담당자 팩스번호 String 20 -

A.6. PBCorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 String 100 O
2 corpName 회사명 String 200 O
3 addr 주소 String 300 O
4 bizType 업태 String 100 O
5 bizClass 종목 String 100 O

A.7. PBContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 담당자 추가시 필수, 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 X
9 searchAllAllowYN 담당자 조회권한 설정 Boolean - - true : (회사권한) / false : (개인권한) 중 반환
10 mgrYN 관리자 여부 Boolean - X true : (관리자) / false : (비관리자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 계정상태 Integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환