1. 휴폐업조회

1.1. CheckCorpNum - 단건 조회

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

CorpState checkCorpNum(string MemberCorpNum, string CheckCorpNum, string UserID = null)

Parameters

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

Return

CorpState

Throws

PopbillException

1.2. CheckCorpNums - 대량 조회

ㆍ 다수 사업자번호에 대한 휴폐업정보를 조회합니다. (최대 1000건)

List<CorpState> checkCorpNums(string MemberCorpNum, List<string> CorpNumList, string UserID = null))

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpNumList List<string> 1000 O [배열] 조회할 사업자번호 (최대 1,000건)
3 UserID string 50 - 팝빌회원 아이디

Return

List<CorpState>

Throws

PopbillException

2. 포인트 관리

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

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

Double GetBalance(string CorpNum)

Parameters

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

Return

Double - 연동회원 잔여포인트

Throws

PopbillException

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

ㆍ 팝빌 연동회원 사업자의 포인트 충전 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

string GetChargeURL(string CorpNum, string UserID)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

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

Double GetPartnerBalance(string CorpNum)

Parameters

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

Return

Double - 파트너 잔여포인트

Throws

PopbillException

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

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

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

string GetPartnerURL(string CorpNum, string TOGO)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO string - O CHRG : 파트너 포인트 충전

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

2.5. GetUnitCost - 조회 단가 확인

ㆍ 휴폐업조회 단가를 확인합니다.

Single GetUnitCost(string CorpNum, string UserID = null)

Parameters

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

Return

Single - 휴폐업조회 단가

Throws

PopbillException

2.6. GetChargeInfo - 과금정보 확인

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

ChargeInfo GetChargeInfo(string CorpNum, string UserID = null)

Parameters

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

Return

ChargeInfo

Throws

PopbillException

3. 회원정보

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

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

Response CheckIsMember(string CorpNum, string LinkID)

Parameters

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

Return

Response

Throws

PopbillException

3.2. CheckID - 아이디 중복 확인

ㆍ 팝빌회원 아이디 중복여부를 확인합니다.

Response CheckID(string ID)

Parameters

순번 변수명 타입 길이 필수 설명
1 ID string 10 O 중복여부 확인 할 아이디

Return

Response

Throws

PopbillException

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

ㆍ 사업자의 연동회원 가입처리를 요청합니다.

Response JoinMember(JoinForm joinInfo)

Parameters

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

Return

Response

Throws

PopbillException

3.4. GetCorpInfo - 회사정보 확인

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

CorpInfo GetCorpInfo(string CorpNum, string UserID = null)

Parameters

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

Return

CorpInfo

Throws

PopbillException

3.5. UpdateCorpInfo - 회사정보 수정

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

Response UpdateCorpInfo(string CorpNum, CorpInfo corpInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

3.6. RegistContact - 담당자 등록

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

ㆍ 하나의 사업자번호에 다수의 담당자 정보(팝빌 로그인 계정)를 추가할 수 있습니다.

Response RegistContact(string CorpNum, Contact contactInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

3.7. ListContact - 담당자 목록 확인

ㆍ 팝빌 연동회원 사업자의 담당자 목록을 확인합니다.

List<Contact> ListContact(string CorpNum, string UserID = null)

Parameters

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

Return

List<Contact>

Throws

PopbillException

3.8. UpdateContact - 담당자 정보 수정

ㆍ 팝빌 연동회원 사업자의 담당자 정보를 수정합니다.

Response UpdateContact(string CorpNum, Contact contactInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

3.9. GetAccessURL - 팝빌 로그인 URL

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

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

string GetAccessURL(string CorpNum, string UserID)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리 실패에 대한 오류코드(-로 시작하는 8자리 숫자값)
2 Message 메시지 string - API 처리 실패에 대한 오류메시지

A.3. CorpState

순번 변수명 항목명 타입 길이 비고
1 corpNum 사업자번호 string - 조회한 사업자번호
2 type 사업자 과세유형 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. ChargeInfo

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

A.5. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
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. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
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. Contact

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 string 50 O 6자 이상 50자 미만
2 pwd 비밀번호 string 20 O 6자 이상 20자 미만
3 personName 담당자 성명 string 100 O
4 tel 담당자 연락처 string 20 -
5 hp 담당자 휴대폰번호 string 20 -
6 fax 담당자 팩스번호 string 20 -
7 email 담당자 이메일 string 100 O
8 regDT 등록일시 string 14 -
9 searchAllAllowYN 담당자 조회권한 설정 Bool? - O
10 mgrYN 관리자 여부 Bool? - O True-관리자 / False-사용자
11 state 상태 Integer 1 - 0–승인대기 / 1–사용중