연동매뉴얼

Index

1. 현금영수증 발행

1.1. CheckMgtKeyInUse - 문서번호 사용여부 확인

ㆍ파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.

ㆍ이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.

Function CheckMgtKeyInUse(CorpNum As String, mgtKey As String) As PBResponse

Parameters

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

Return

PBResponse

Throws

Err

1.2. RegistIssue - 즉시 발행

ㆍ작성된 현금영수증 데이터를 팝빌에 저장과 동시에 발행하여 "발행완료" 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책

Function RegistIssue(CorpNum As String, Cashbill As PBCashbill, Optional UserID As String = "", Optional emailSubject As String = "") As PBResponse
유의사항

ㆍ현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)

ㆍ현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Cashbill PBCashbill - O 현금영수증 객체정보
3 UserID String 50 - 팝빌회원 아이디
4 emailSubject string 300 - 현금영수증 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용

Return

PBResponse

Throws

Err

1.3. BulkSubmit - 초대량 발행 접수

ㆍ최대 100건의 현금영수증 발행을 한번의 요청으로 접수합니다.

Function BulkSubmit(CorpNum As String, submitID As String, cashbillList As Collection, Optional UserID As String = "") As PBBulkResponse
유의사항

ㆍ현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)

ㆍ현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SubmitID String 36 O 제출아이디
└ 최대 36자리 영문, 숫자, '-' 조합으로 구성
3 cashbillList Collection of PBCashbill 100 O 현금영수증 객체정보 목록
4 UserID String 50 - 팝빌회원 아이디

Return

PBBulkResponse

Throws

PopbillException

1.4. GetBulkResult - 초대량 접수결과 확인

ㆍ접수시 기재한 SubmitID를 사용하여 현금영수증 접수결과를 확인합니다.

ㆍ개별 현금영수증 처리상태는 접수상태(txState)가 완료(2) 시 반환됩니다.

Function GetBulkResult(CorpNum As String, submitID As String, Optional UserID As String = "") As PBBulkCashbillResult

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SubmitID String 36 O 초대량 발행 접수시 기재한 제출아이디
3 UserID String 50 - 팝빌회원 아이디

Return

PBBulkCashbillResult

Throws

PopbillException

1.5. Delete - 삭제

ㆍ삭제 가능한 상태의 현금영수증을 삭제합니다.

※ 삭제 가능한 상태: "전송실패"

Function Delete(CorpNum As String, mgtKey As String, Optional UserID As String = "") As PBResponse

ㆍ삭제처리된 현금영수증의 문서번호는 재사용이 가능합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

1.6. RevokeRegistIssue - 취소 현금영수증 즉시발행

ㆍ작성된 취소 현금영수증 데이터를 팝빌에 저장과 동시에 발행하여 "발행완료" 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책

※ 취소 현금영수증의 금액은 원본 금액을 넘을 수 없습니다.

※ 원본 현금영수증의 거래일시보다 과거의 거래일시를 입력할 수 없습니다.

Function RevokeRegistIssue(CorpNum As String, mgtKey As String, orgConfirmNum As String, orgTradeDate As String, Optional smssendYN As Boolean = False, Optional memo As String = "", Optional UserID As String = "", Optional isPartCancel As Boolean = False, Optional cancelType As Integer = 0, Optional supplyCost As String = "", Optional tax As String = "", Optional serviceFee As String = "", Optional totalAmount As String = "", Optional emailSubject As String = "", Optional tradeDT As String = "") As PBResponse
유의사항

ㆍ원본 현금영수증의 국세청 승인번호와 거래일자는 [2.1 GetInfo – 상태확인]함수를 통해 확인 가능합니다.

ㆍ취소 현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
※ 영문, 숫자, 하이픈('-')을 이용하여 24자리 이하의 고유한 값 할당
3 orgConfirmNum String 9 O 원본 현금영수증의 국세청 승인번호
└ 'PBCbInfo'의 변수 'confirmNum'를 통해 내용 확인 가능
4 orgTradeDate String 8 O 원본 현금영수증의 거래일자 (형식 : yyyyMMdd)
└ 'PBCbInfo'의 변수 'tradeDate'를 통해 내용 확인 가능
5 smssendYN Boolean - - 현금영수증 발행시 알림문자 전송여부 : true / false 중 택 1
└ true = 전송, false = 미전송
└ 원본 현금영수증의 구매자(고객)의 휴대폰번호 문자 전송
6 memo String 200 - 현금영수증 상태 이력을 관리하기 위한 메모
7 UserID String 50 - 팝빌회원 아이디
8 isPartCancel Boolean - △ 현금영수증 취소유형 : true / false 중 택 1
└ true = 부분 취소, false = 전체 취소
9 cancelType Integer 1 - 현금영수증 취소사유 : 1 / 2 / 3 중 택 1
└ 1 = 거래취소, 2 = 오류발급취소, 3 = 기타
10 supplyCost String 9 △ 공급가액
└ {@no. 8 isPartCancel} 값이 true 인 경우 취소할 공급가액 입력
└ {@no. 8 isPartCancel} 값이 false 인 경우 미입력
11 tax String 9 △ 부가세
└ {@no. 8 isPartCancel} 값이 true 인 경우 취소할 부가세 입력
└ {@no. 8 isPartCancel} 값이 false 인 경우 미입력
12 serviceFee String 9 △ 봉사료
└ {@no. 8 isPartCancel} 값이 true 인 경우 취소할 봉사료 입력
└ {@no. 8 isPartCancel} 값이 false 인 경우 미입력
13 totalAmount String 9 △ 거래금액 (공급가액+부가세+봉사료)
└ {@no. 8 isPartCancel} 값이 true 인 경우 취소할 거래금액 입력
└ {@no. 8 isPartCancel} 값이 false 인 경우 미입력
14 emailSubject String 300 - 현금영수증 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용
15 tradeDT String 14 - 거래일시 (형식 : yyyyMMddHHmmss)
└ 전날부터 당일까지 입력가능
※ 미입력시 기본값 발행일시 처리

Return

PBResponse

Throws

Err

2. 현금영수증 정보확인

2.1. GetInfo - 상태 확인

ㆍ현금영수증 1건의 상태 및 요약정보를 확인합니다.

ㆍ리턴값 'PBCbInfo'의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.

Function GetInfo(CorpNum As String, mgtKey As String, Optional UserID As String = "") As PBCbInfo

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

PBCbInfo

Throws

Err

2.2. GetInfos - 다수건 상태 확인

ㆍ다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)

ㆍ리턴값 'PBCbInfo'의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.

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

ㆍ문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyList Collection 1000 O [배열] 조회할 현금영수증 문서번호 (최대 1,000건)
3 UserID String 50 - 팝빌회원 아이디

Return

PBCbInfo[ ]

Throws

Err

2.3. GetDetailInfo - 상세정보 확인

ㆍ현금영수증 1건의 상세정보를 확인합니다.

Function GetDetailInfo(CorpNum As String, mgtKey As String, Optional UserID As String = "") As PBCashbill

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

PBCashbill

Throws

Err

2.4. Search - 목록 조회

ㆍ검색조건에 해당하는 현금영수증을 조회합니다. (조회기간 단위 : 최대 6개월)

Function Search(CorpNum As String, DType As String, SDate As String, EDate As String, state As Collection, tradeType As Collection, tradeUsage As Collection, taxationType As Collection, Page As Integer, PerPage As Integer, Order As String, Optional QString As String, Optional tradeOpt As Collection = Null, Optional franchiseTaxRedID As String) As PBCBSearchList

ㆍ페이지 관련 항목(Page, PerPage, Order)을 활용하여 현금영수증 목록 페이지 기능을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 DType String 1 O 조회 기준일자 유형 : "R" / "T" / "I" 중 택 1
└ R = 등록일자, T = 거래일자, I = 발행일시
3 SDate String 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
4 EDate String 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
5 state Collection - O [배열] 현금영수증 상태코드
└ 상태코드 2,3번째 자리에 와일드카드(*) 사용가능, 예) "3**"
6 tradeType Collection - O [배열] 현금영수증 문서형태 : "N" / "C" 중 선택 (다중 선택 가능)
└ N = 일반 현금영수증, C = 취소 현금영수증
7 tradeUsage Collection - O [배열] 거래구분 : "P" / "C" 중 선택 (다중 선택 가능)
└ P = 소득공제용, C = 지출증빙용
8 taxationType Collection - O [배열] 과세형태 : "T" / "N" 중 선택 (다중 선택 가능)
└ T = 과세, N = 비과세
9 Page int - O 목록 페이지번호 (기본값 1)
10 PerPage int - O 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
11 Order String 1 O {@no.2 DType} 값을 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
12 QString String - - 현금영수증 식별번호 조회
※ 미입력시 전체조회
13 tradeOpt Collection - - [배열] 거래유형 : "N" / "B" / "T" 중 선택 (다중 선택 가능)
└ N = 일반, B = 도서공연, T = 대중교통
14 FranchiseTaxRegID String - - 가맹점 종사업장번호
└ 다수건 검색시 콤마(",")로 구분. 예) 1234,1000
※ 미입력시 전체조회

Return

PBCBSearchList

Throws

Err

2.5. GetURL - 팝빌 현금영수증 문서함 관련 URL

ㆍ로그인 상태로 팝빌 사이트의 현금영수증 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

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

Function GetURL(CorpNum As String, UserID As String, TOGO As String) As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디
3 TOGO String - O 접근 메뉴 : "TBOX" / "PBOX" / "WRITE" 중 택 1
└ TBOX = 임시 문서함, PBOX = 발행 문서함, WRITE = 현금영수증 작성 중 택 1

Return

String - 요청에 대한 응답 URL

Throws

Err

3. 현금영수증 보기/인쇄

3.1. GetPopUpURL - 현금영수증 상세 정보 팝업 URL

ㆍ현금영수증 1건의 상세 정보 페이지의 URL을 반환합니다.

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

Function GetPopUpURL(CorpNum As String, mgtKey As String, Optional UserID As String = "") As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.2. GetViewURL - 현금영수증 상세 정보 팝업 URL [메뉴/버튼 제외]

ㆍ현금영수증 1건의 상세 정보 페이지(사이트 상단, 좌측 메뉴 및 버튼 제외)의 URL을 반환합니다.

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

Function GetViewURL(CorpNum As String, mgtKey As String, Optional UserID As String = "") As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.3. GetPrintURL - 현금영수증 인쇄 팝업 URL

ㆍ현금영수증 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다.

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

Function GetPrintURL(CorpNum As String, mgtKey As String, Optional UserID As String = "") As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.4. GetMassPrintURL - 현금영수증 대량 인쇄 팝업 URL

ㆍ다수건의 현금영수증을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다. (최대 100건)

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

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyList Collection 100 O [배열] 인쇄할 현금영수증 문서번호 (최대 100건)
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.5. GetMailURL - 현금영수증 안내메일 버튼 팝업 URL

ㆍ현금영수증 안내메일의 상세보기 링크 URL을 반환합니다.

ㆍ함수 호출로 반환 받은 URL에는 유효시간이 없습니다.

Function GetMailURL(CorpNum As String, mgtKey As String, Optional UserID As String = "") As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.6. GetPDFURL - 현금영수증 PDF 다운로드 URL

ㆍ현금영수증 PDF 파일을 다운 받을 수 있는 URL을 반환합니다.

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

Function GetPDFURL(CorpNum As String, mgtKey As String, Optional UserID As String = "") As String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

4. 부가기능

4.1. 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 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

4.2. SendEmail - 메일 재전송

ㆍ현금영수증과 관련된 안내 메일을 재전송 합니다.

Function SendEmail(CorpNum As String, mgtKey As String, Receiver As String, Optional UserID As String = "") As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 이메일 재전송할 현금영수증 문서번호
3 Receiver String - O 수신자 이메일주소
4 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

4.3. SendSMS - 문자 재전송

ㆍ현금영수증과 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.

ㆍ메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)

Function SendSMS(CorpNum As String, mgtKey As String, Sender As String, Receiver As String, Contents As String, Optional UserID As String = "") As PBResponse
유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 Sender String - O 발신번호
4 Receiver String - O 수신번호
5 Contents String 90 O 메시지 내용
※ 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
6 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

4.4. SendFAX - 팩스 전송

ㆍ현금영수증을 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.

Function SendFax(CorpNum As String, mgtKey As String, Sender As String, Receiver As String, Optional UserID As String = "") As PBResponse
유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey String 24 O 파트너가 할당한 문서번호
3 Sender String - O 발신번호
4 Receiver String - O 수신번호
5 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

4.5. AssignMgtKey - 문서번호 할당

ㆍ팝빌 사이트를 통해 발행하여 문서번호가 부여되지 않은 현금영수증에 문서번호를 할당합니다.

Function AssignMgtKey(CorpNum As String, itemKey As String, mgtKey As String, Optional UserID As String = "") As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemKey String 18 O 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
└ 함수 [2.4. Search – 목록 조회]를 통하여 CashbillInfo의 'itemKey'를 확인
3 mgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

4.6. ListEmailConfig - 현금영수증 알림메일 발송설정 조회

ㆍ현금영수증 관련 메일 항목에 대한 발송설정을 확인합니다.

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

Parameters

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

Return

PBEmailConfig[ ]

Throws

Err

4.7. UpdateEmailConfig - 현금영수증 알림메일 발송설정 수정

ㆍ현금영수증 관련 메일 항목에 대한 발송설정을 수정합니다.

Function UpdateEmailConfig(CorpNum As String, emailType As String, sendYN As Boolean, Optional UserID As String = "") As PBResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 emailType String - O * 발송 메일 유형
CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일
3 sendYN Boolean - O 전송 여부
4 UserID String 50 - 팝빌회원 아이디

Return

PBResponse

Throws

Err

5. 포인트 관리

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

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

Function GetBalance(CorpNum As String) As Double

Parameters

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

Return

Double - 연동회원 잔여포인트

Throws

Err

5.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

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

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

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

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

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

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

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

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

Function GetPartnerBalance(CorpNum As String) As Double

Parameters

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

Return

Double - 파트너 잔여포인트

Throws

Err

5.6. 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

5.7. GetUnitCost - 발행 단가 확인

ㆍ현금영수증 발행시 과금되는 포인트 단가를 확인합니다.

Function GetUnitCost(CorpNum As String) As Double

Parameters

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

Return

Double - 현금영수증 발행단가

Throws

Err

5.8. 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

6. 회원정보

6.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 - code : 0 (미가입) / code : 1 (가입)

Throws

Err

6.2. CheckID - 아이디 중복 확인

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

Function CheckID(IDString As String) As PBResponse

Parameters

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

Return

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

Throws

Err

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

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

Function JoinMember(JoinInfo As PBJoinForm) As PBResponse

Parameters

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

Return

PBResponse

Throws

Err

6.4. 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

6.5. 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

6.6. 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

6.7. GetContactInfo - 담당자 정보 확인

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

Function GetContactInfo(CorpNum As String, ContactID As String, Optional UserID As String = "") As PBContactInfo

Parameters

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

Return

PBContactInfo

Throws

Err

6.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

6.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 처리에 대한 응답메시지
3 confirmNum 국세청 승인번호 String 9 현금영수증 발행 시점에 팝빌에서 자동으로 부여

※ RegistIssue, RevokeRegistIssue API 사용할 경우만 존재

4 tradeDate 거래일자 String 8 현금영수증 발행 시점에 팝빌에서 자동으로 부여 (형식 : yyyyMMdd)

※ RegistIssue, RevokeRegistIssue API 사용할 경우만 존재

5 tradeDT 거래일시 String 14 형식 : yyyyMMddHHmmss

※ RegistIssue, RevokeRegistIssue API 사용할 경우만 존재

A.2. Err (Property)

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

A.3. PBCashbill

순번 변수명 항목명 타입 길이 필수 비고
1 mgtKey 문서번호 String 24 O 현금영수증 관리를 위해 파트너가 할당하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
2 confirmNum 국세청 승인번호 String 9 X 현금영수증 발행 시점에 팝빌에서 자동으로 부여
3 orgConfirmNum 원본 현금영수증
국세청 승인번호		 String 9 △ 취소 현금영수증 작성시 필수
4 orgTradeDate 원본 현금영수증 거래일자 String 8 △ 취소 현금영수증 작성시 필수
5 tradeDate 거래일자 String 8 X 현금영수증을 발행한 날짜 (형식 : yyyyMMdd)
※ 거래일자는 입력 할 수 없음
6 tradeDT 거래일시 String 14 - 거래일시 (형식 : yyyyMMddHHmmss)
└ 전날부터 당일까지 입력가능
※ 미입력시 기본값 발행일시 처리
7 tradeType 문서형태 String 4 O "승인거래" / "취소거래"
└ "승인거래" 현금영수증은 [1.2. RegistIssue]함수 사용하여 발행
└ "취소거래" 현금영수증은 [1.6. RevokeRegistIssue]함수 사용하여 발행
8 tradeUsage 거래구분 String - O "소득공제용" / "지출증빙용" 중 택 1
9 tradeOpt 거래유형 String 4 - "일반" / "도서공연" / "대중교통" 중 택 1
10 taxationType 과세형태 String - O "과세" / "비과세" 중 택 1
11 totalAmount 거래금액 String 9 O 양수만 입력
12 supplyCost 공급가액 String 9 O 양수만 입력
13 tax 부가세 String 9 O 양수만 입력
14 serviceFee 봉사료 String 9 O 양수만 입력
15 franchiseCorpNum 가맹점 사업자번호 String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
16 franchiseTaxRegID 가맹점 종사업장 식별번호 String 4 - 4자리 숫자값
17 franchiseCorpName 가맹점 상호 String 200 -
18 franchiseCEOName 가맹점 대표자 성명 String 100 -
19 franchiseAddr 가맹점 주소 String 400 -
20 franchiseTEL 가맹점 전화번호 String 20 -
21 identityNum 식별번호 String 19 O {@no.8 tradeUsage} 값이 "소득공제용" 인 경우
└ 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 입력
{@no.8 tradeUsage} 값이 "지출증빙용" 인 경우
└ 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 입력
※ 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
22 customerName 구매자(고객) 성명 String 70 -
23 itemName 주문상품명 String 70 -
24 orderNumber 주문번호 String 200 -
25 email 구매자(고객) 이메일 String 100 -
26 hp 구매자(고객) 휴대폰 String 20 - {@no.27 smssendYN} 값이 true 인 경우 이 값으로 안내 문자 전송
27 smssendYN SMS 전송여부 Boolean - - true : (전송) / false : (미전송)
28 faxsendYN FAX 전송여부 Boolean - - true : (전송) / false : (미전송)
29 cancelType 취소사유 Integer 1 - null : (일반 현금영수증) / 1 : (거래취소) / 2 : (오류발급취소) / 3 : (기타) 중 택 1

A.4. PBBulkResponse

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 응답메시지 String - API 처리에 대한 응답메시지
3 receiptID 접수아이디 String 24 접수 시점에 팝빌에서 자동으로 부여

A.5. PBBulkCashbillResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 응답메시지 String - API 처리에 대한 응답메시지
3 submitID 제출아이디 String 36 접수 시점에 고객사에서 부여한 제출아이디
4 submitCount 현금영수증 접수 건수 long -
5 successCount 현금영수증 발행 성공 건수 long -
6 failCount 현금영수증 발행 실패 건수 long -
7 txState 접수상태코드 long - 0 : (접수) / 1 : (처리중) / 2 : (처리완료) 중 반환
8 txResultCode 접수 결과코드 long -
9 txStartDT 발행처리 시작일시 String 14 형식 : yyyyMMddHHmmss
10 txEndDT 발행처리 완료일시 String 14 형식 : yyyyMMddHHmmss
11 receiptDT 접수일시 String 14 형식 : yyyyMMddHHmmss
12 issueResult 발행결과 PBBulkCashbillIssueResult[ ] {@no.7 txState} = 2 경우 반환
13 receiptID 접수아이디 String 36 접수 시점에 팝빌에서 자동으로 부여

A.6. PBBulkCashbillIssueResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 mgtKey 문서번호 String 24
4 confirmNum 국세청 승인번호 String 9 현금영수증 발행 시점에 팝빌에서 자동으로 부여
5 tradeDate 거래일자 String 8 현금영수증 발행 시점에 팝빌에서 자동으로 부여 (형식 : yyyyMMdd)
6 tradeDT 거래일시 String 14 형식 : yyyyMMddHHmmss

A.7. PBCBSearchList

순번 변수명 항목명 타입 길이 비고
1 code 코드 Integer - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 Integer -
4 perPage 페이지당 검색개수 Integer -
5 pageNum 페이지 번호 Integer -
6 pageCount 페이지 개수 Integer -
7 list 현금영수증 상태/요약정보 PBCbInfo[ ] [배열] 최대 1,000건
└ 함수 [2.1. GetInfo - 상태 확인]의 리턴값 구성과 동일

A.8. PBCbInfo

순번 변수명 항목명 타입 길이 비고
1 itemKey 팝빌번호 String 18 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
2 mgtKey 문서번호 String 24 현금영수증 관리를 위해 파트너가 할당하는 식별번호
3 tradeDate 거래일자 String 8 형식 : yyyyMMdd
4 tradeDT 거래일시 String 14 형식 : yyyyMMddHHmmss
5 tradeType 문서형태 String 4 "승인거래" / "취소거래" 중 반환
6 tradeUsage 거래구분 String 5 "소득공제용" / "지출증빙용" 중 반환
7 tradeOpt 거래유형 String 4 "일반" / "도서공연" / "대중교통" 중 반환
8 taxationType 과세형태 String 3 "과세" / "비과세" 중 반환
9 totalAmount 거래금액 String 9
10 issueDT 발행일시 String 14 형식 : yyyyMMddHHmmss
11 regDT 등록일시 String 14 형식 : yyyyMMddHHmmss
12 stateMemo 상태메모 String 200
13 stateCode 상태코드 Integer 3 300 / 304 / 305 중 반환
└ 300 : 발행완료 , 304 : 전송성공 , 305 : 전송실패
14 stateDT 상태변경일시 String 14 형식 : yyyyMMddHHmmss
15 identityNum 식별번호 String 19 {@no.6 tradeUsage} 값이 "소득공제용" 인 경우
└ 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 반환
{@no.6 tradeUsage} 값이 "지출증빙용" 인 경우
└ 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 반환
16 itemName 주문상품명 String 70
17 customerName 구매자(고객) 성명 String 70
18 confirmNum 국세청 승인번호 String 9 현금영수증 발행 시점에 팝빌에서 자동으로 부여
19 orgConfirmNum 원본 현금영수증
국세청 승인번호		 String 9 {@no.5 tradeType} 값이 "취소거래"인 경우만 존재
20 orgTradeDate 원본 현금영수증 거래일자 String 8 {@no.5 tradeType} 값이 "취소거래"인 경우만 존재
21 ntssendDT 국세청 전송일시 String 14 형식 : yyyyMMddHHmmss
22 ntsresultDT 국세청 처리결과 수신일시 String 14 형식 : yyyyMMddHHmmss
23 ntsresultCode 국세청 처리결과 상태코드 String 4 [참고] 국세청 전송 결과코드
24 ntsresultMessage 국세청 처리결과 메시지 String 30
25 printYN 인쇄여부 Boolean - true : (인쇄) / false : (미인쇄) 중 반환

A.9. PBEmailConfig

순번 변수명 항목명 타입 길이 비고
1 emailType 메일전송유형 String -

CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일

2 sendYN 전송여부 Boolean - true : (전송) / false : (미전송) 중 반환

A.10. PBChargeInfo

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

A.11. PBJoinForm

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

A.12. 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.13. PBContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 이하
2 Password 비밀번호 String 20 △ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 email 담당자 이메일 String 100 O
6 regDT 등록일시 String 14 X 형식 : yyyyMMddHHmmss
7 searchRole 담당자 권한 Integer 1 - 1 : (개인권한) / 2 : (읽기권한) / 3 : (회사권한)
8 mgrYN 관리자 여부 Boolean - X true : (관리자) / false : (담당자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
9 state 계정상태 Integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환