Index

1. 홈택스 현금영수증 매입/매출 내역 수집

1.1. RequestJob - 수집 요청

ㆍ홈택스에 신고된 현금영수증 매입/매출 내역 수집을 팝빌에 요청합니다. (조회기간 단위 : 최대 3개월)

String requestJob(String CorpNum, QueryType queryType, String SDate, String EDate, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 queryType QueryType - O 현금영수증 유형 : SELL / BUY 중 택 1
└ SELL = 매출, BUY = 매입
3 SDate String - O 조회 기간의 시작일자 (형식 : yyyyMMdd)
※ 현금영수증의 거래일자를 기준으로 조회
4 EDate String - O 조회 기간의 종료일자 (형식 : yyyyMMdd)
※ 현금영수증의 거래일자를 기준으로 조회
5 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 작업아이디(JobID)

Throws

PopbillException

1.2. GetJobState - 수집 상태 확인

ㆍ함수 [1.1. RequestJob – 수집 요청]를 통해 반환 받은 작업 아이디의 상태를 확인합니다.

[2.1 Search – 수집 결과 조회] 또는 [2.2 Summary – 수집결과 요약정보 조회]를 사용하기 전에 수집 작업의 진행 상태, 수집 작업의 성공 여부를 확인해야 합니다.

HTCashbillJobState getJobState(String CorpNum, String JobID, String UserID) throws PopbillException

Parameters

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

Return

HTCashbillJobState

Throws

PopbillException

1.3. ListActiveJob - 수집 상태 목록 확인

ㆍ현금영수증 매입/매출 내역 수집요청에 대한 상태 목록을 확인합니다.

ㆍ수집 요청 후 1시간이 경과한 수집 요청건은 상태정보가 반환되지 않습니다.

HTCashbillJobState[] listActiveJob(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

HTCashbillJobState[ ]

Throws

PopbillException

2. 홈택스 현금영수증 매입/매출 내역 수집 결과 조회

2.1. Search - 수집 결과 조회

[1.2 GetJobState – 수집 상태 확인]를 통해 상태 정보 확인된 작업아이디를 활용하여 현금영수증 매입/매출 내역을 조회합니다.

HTCashbillSearchResult search(String CorpNum, String JobID, String[] TradeUsage, String[] TradeType, Integer Page, Integer PerPage, String Order, String UserID) throws PopbillException

ㆍ페이지 정보(Page, PerPage, Order) 항목을 사용하여 현금영수증 매입/매출 목록 페이징 기능을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID String 18 O 작업 아이디
[2.1 RequestJob - 수집 요청]의 반환값
3 TradeUsage String[ ] - - [배열] 현금영수증 거래구분 : "P" / "C" 중 선택 (다중 선택 가능)
└ P = 소득공제용, C = 지출증빙용
※ 미입력시 전체조회
4 TradeType String[ ] - - [배열] 현금영수증 문서형태 : "N" / "C" 중 선택 (다중 선택 가능)
└ N = 일반 현금영수증 / C = 취소 현금영수증
※ 미입력시 전체조회
5 Page Integer - - 목록 페이지번호 (기본값 1)
6 PerPage Integer - - 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
7 Order String 1 - 현금영수증 거래일자를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
8 UserID String 50 - 팝빌회원 아이디

Return

HTCashbillSearchResult

Throws

PopbillException

2.2. Summary - 수집 결과 요약정보 조회

ㆍ함수 [1.2. GetJobState – 수집 상태 확인]를 통해 상태 정보가 확인된 작업아이디를 활용하여 수집된 현금영수증 매입/매출 내역의 요약 정보를 조회합니다.

※ 요약정보: 현금영수증 수집 건수, 공급가액 합계, 세액 합계, 봉사료 합계, 합계 금액

HTCashbillSummary summary(String CorpNum, String JobID, String[] TradeUsage, String[] TradeType, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID String 18 O 작업 아이디
[2.1 RequestJob - 수집 요청]의 반환값
3 TradeUsage String[ ] - - [배열] 현금영수증 거래구분 : "P" / "C" 중 선택 (다중 선택 가능)
└ P = 소득공제용, C = 지출증빙용
※ 미입력시 전체조회
4 TradeType String[ ] - - [배열] 현금영수증 문서형태 : "N" / "C" 중 선택 (다중 선택 가능)
└ N = 일반 현금영수증 / C = 취소 현금영수증
※ 미입력시 전체조회
5 UserID String 50 - 팝빌회원 아이디

Return

HTCashbillSummary

Throws

PopbillException

3. 홈택스연동 인증 관리

3.1. GetCertificatePopUpURL - 홈택스연동 인증 관리 팝업 URL

ㆍ홈택스연동 인증정보를 관리하는 페이지의 팝업 URL을 반환합니다.

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

String getCertificatePopUpURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

3.2. GetCertificateExpireDate - 인증서 만료일자 확인

ㆍ홈택스연동 인증을 위해 팝빌에 등록된 인증서 만료일자를 확인합니다.

Date getCertificateExpireDate(String CorpNum) throws PopbillException

Parameters

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

Return

Date - 팝빌에 등록된 인증서 만료일자

Throws

PopbillException

3.3. CheckCertValidation - 인증서 로그인 테스트

ㆍ팝빌에 등록된 인증서로 홈택스 로그인 가능 여부를 확인합니다.

Response checkCertValidation(String CorpNum) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

3.4. RegistDeptUser - 부서사용자 계정등록

ㆍ홈택스연동 인증을 위해 팝빌에 현금영수증 자료조회 부서사용자 계정을 등록합니다.

Response registDeptUser(String CorpNum, String DeptUserID, String DeptUserPWD) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 DeptUserID String 50 O 현금영수증 전용 부서사용자 계정 아이디
3 DeptUserPWD String 50 O 현금영수증 전용 부서사용자 계정 비밀번호

Return

Response

Throws

PopbillException

3.5. CheckDeptUser - 부서사용자 등록정보 확인

ㆍ홈택스연동 인증을 위해 팝빌에 등록된 현금영수증 자료조회 부서사용자 계정을 확인합니다.

Response checkCertValidation(String CorpNum) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

3.6. CheckLoginDeptUser - 부서사용자 로그인 테스트

ㆍ팝빌에 등록된 현금영수증 자료조회 부서사용자 계정 정보로 홈택스 로그인 가능 여부를 확인합니다.

Response checkLoginDeptUser(String CorpNum) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

3.7. DeleteDeptUser - 부서사용자 등록정보 삭제

ㆍ팝빌에 등록된 홈택스 현금영수증 자료조회 부서사용자 계정을 삭제합니다.

Response deleteDeptUser(String CorpNum) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

4. 정액제 신청 / 포인트 관리

4.1. GetFlatRatePopUpURL - 정액제 서비스 신청 팝업 URL

ㆍ홈택스연동 정액제 서비스 신청 페이지의 팝업 URL을 반환합니다.

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

String getFlatRatePopUpURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ홈택스연동 정액제 서비스 상태를 확인합니다.

FlatRateState getFlatRateState(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

FlatRateState

Throws

PopbillException

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

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

double getBalance(String CorpNum) throws PopbillException

Parameters

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

Return

double - 연동회원 잔여포인트

Throws

PopbillException

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

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

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

String getChargeURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

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

String getPaymentURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

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

String getUseHistoryURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

double getPartnerBalance(String CorpNum) throws PopbillException

Parameters

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

Return

double - 파트너 잔여포인트

Throws

PopbillException

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

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

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

String getPartnerURL(String CorpNum, String TOGO) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.9. GetChargeInfo - 과금정보 확인

ㆍ팝빌 홈택스연동(현금) API 서비스 과금정보를 확인합니다.

ChargeInfo getChargeInfo(String CorpNum) throws PopbillException

Parameters

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

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

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

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

Response checkIsMember(String CorpNum, String LinkID) throws PopbillException

Parameters

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

Return

Response - code : 0 (미가입) / code : 1 (가입)

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

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

Response checkID(String CheckID) throws PopbillException

Parameters

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

Return

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

Throws

PopbillException

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

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

Response joinMember(JoinForm joinInfo) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

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

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

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

String getAccessURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

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

CorpInfo getCorpInfo(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

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

Response updateCorpInfo(String CorpNum, CorpInfo corpInfo, String UserID) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

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

Response registContact(String CorpNum, ContactInfo contactInfo, String UserID) throws PopbillException

Parameters

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

Return

Response

Throws

PopbillException

5.8. GetContactInfo - 담당자 정보 확인

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

ContactInfo getContactInfo(String CorpNum, String ContactID, String UserID) throws PopbillException

Parameters

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

Return

ContactInfo

Throws

PopbillException

5.9. ListContact - 담당자 목록 확인

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

ContactInfo[] listContact(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

5.10. UpdateContact - 담당자 정보 수정

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

Response updateContact(String CorpNum, ContactInfo contactInfo, String UserID) throws PopbillException

Parameters

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

Return

Response

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. QueryType (enum)

순번 변수명 항목명 타입 길이 비고
1 SELL 매출 enum -
2 BUY 매입 enum -

A.4. HTCashbillJobState

순번 변수명 항목명 타입 길이 비고
1 jobID 작업아이디 String 18
2 jobState 수집상태 String - "1" : (대기) / "2" : (진행) / "3" : (완료) 중 반환
3 queryType 수집유형 String - "매출" / "매입" 중 반환
4 queryDateType 수집 일자 유형 String - "TradeDate" : (거래일자) 반환
5 queryStDate 시작일자 String 8 형식 : yyyyMMdd
6 queryEnDate 종료일자 String 8 형식 : yyyyMMdd
7 errorCode 오류코드 long - 수집 결과 코드 : 1 / -8자리 숫자 값
└ 1 = 수집성공, -8자리 숫자 값 = 수집실패
※ -8자리 숫자의 예) -99999999
8 errorReason 오류메시지 String - 수집실패시 반환되는 사유
9 jobStartDT 작업 시작일시 String 14 형식 : yyyyMMddHHmmss
10 jobEndDT 작업 종료일시 String 14 형식 : yyyyMMddHHmmss
11 collectCount 수집개수 Integer -
12 regDT 수집 요청일시 String 14 형식 : yyyyMMddHHmmss

A.5. HTCashbill

순번 변수명 항목명 타입 길이 비고
1 ntsconfirmNum 국세청 승인번호 String 24 국세청승인번호
2 tradeDate 거래일자 String 8 형식 : yyyyMMdd
3 tradeDT 거래일시 String 14 형식 : yyyyMMddHHmmss
4 tradeType 문서형태 String 4 "승인거래" / "취소거래" 중 반환
5 tradeUsage 거래구분 String 5 "소득공제용" / "지출증빙용" 중 반환
6 totalAmount 거래금액 String 9
7 supplyCost 공급가액 String 9
8 tax 부가세 String 9
9 serviceFee 봉사료 String 9
10 invoiceType 매입/매출 String 2 "매입" / "매출" 중 반환
11 franchiseCorpNum 가맹점(발행자) 사업자번호 String 10 ※ 매입 현금영수증 조회시 반환
12 franchiseCorpName 가맹점(발행자) 상호 String 200 ※ 매입 현금영수증 조회시 반환
13 franchiseCorpType 가맹점(발행자) 사업자유형 String 1 "1" : (일반과세자) / "2" : (간이과세자) / "5" : (법인과세자) 중 반환
※ 매입 현금영수증 조회시 반환
14 identityNum 식별번호 String 4 ※ 반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
15 identityNumType 식별번호유형 String 1 "1" : (주민등록번호) / "2" : (사업자번호) / "3" : (휴대전화번호) / "4" : (카드번호) 중 반환
16 customerName 고객명 String 70
17 cardOwnerName 카드소유자명 String 70
18 deductionType 공제유형 String 1 "1" or "2" : (공제) / "3" or "4" : (불공제) 중 반환

A.6. HTCashbillSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 long -
4 perPage 페이지당 검색개수 long -
5 pageNum 페이지 번호 long -
6 pageCount 페이지 개수 long -
7 list 현금영수증 정보 List<HTCashbill> [리스트] 최대 1,000건

A.7. HTCashbillSummary

순번 변수명 항목명 타입 길이 비고
1 count 수집 결과 건수 long -
2 supplyCostTotal 공급가액 합계 long -
3 taxTotal 세액 합계 long -
4 serviceFeeTotal 봉사료 합계 long -
5 amountTotal 합계 금액 long -

A.8. FlatRateState

순번 변수명 항목명 타입 길이 비고
1 referenceID 사업자번호 String 10 하이픈 '-' 제외 10자리 숫자값
2 contractDT 정액제 서비스 시작일시 String 14 형식 : yyyyMMddHHmmss
3 useEndDate 정액제 서비스 종료일자 String 8 형식 : yyyyMMdd
4 baseDate 자동연장 결제일 Short - 5 / 15 / 25 중 반환
5 state 정액제 서비스 상태 Short - 1 : (사용) / 2 : (해지) 중 반환
6 closeRequestYN 정액제 서비스 해지신청 여부 Boolean - true : (신청) / false : (미신청) 중 반환
7 useRestrictYN 정액제 서비스 사용제한 여부 Boolean - true : (제한) / false : (미제한) 중 반환
8 closeOnExpired 정액제 서비스 만료시 해지 여부 Boolean - true : (해지) / false : (미해지) 중 반환
9 unPaidYN 미수금 보유 여부 Boolean - true : (보유) / false : (미보유) 중 반환

A.9. ChargeInfo

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

A.10. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 미만
2 Password 비밀번호 String 20 O 8자 이상 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.11. 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.12. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 Password 비밀번호 String 20 8자 이상 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 searchRole 담당자 권한 Integer - - 1 / 2 / 3 중 입력 또는 반환
└ 1 : 개인권한 / 2 : 읽기권한 / 3 : 회사권한
10 mgrYN 관리자 여부 Boolean - X true : (관리자) / false : (비관리자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 계정상태 Integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환