Index
ㆍ파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.
ㆍ이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.
def checkMgtKeyInUse(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 확인할 문서번호 |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Boolean - true : (사용중) / false : (미사용중)
Throws
ㆍ현금영수증 데이터를 팝빌에 전송하여 발행합니다. [참고] 팝빌 국세청 전송 정책
※ 발행된 현금영수증의 상태는 "발행완료" 입니다.
ㆍ"발행완료"된 현금영수증은 국세청 전송 이전에 [1.3 CancelIssue – 발행취소] 함수로 국세청 신고 대상에서 제외할 수 있습니다.
def registIssue(corpNum, cashbill, memo = '', userID = '', emailSubject = '')
ㆍ현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)
ㆍ현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | cashbill | Cashbill | - | O | 현금영수증 객체정보 |
3 | memo | String | 200 | O | 현금영수증 상태 이력을 관리하기 위한 메모 |
4 | userID | String | 50 | - | 팝빌회원 아이디 |
5 | emailSubject | String | 300 | - |
현금영수증 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용 |
Return
Throws
ㆍ국세청 전송 이전 "발행완료" 상태의 현금영수증을 "발행취소"하고 국세청 전송 대상에서 제외됩니다.
def cancelIssue(corpNum, mgtKey, memo = '', userID = '')
ㆍ[1.4. Delete – 삭제]함수를 호출하여 "발행취소" 상태의 현금영수증을 삭제하면, 문서번호 재사용이 가능합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | memo | String | 200 | - | 현금영수증 상태 이력을 관리하기 위한 메모 |
4 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ국세청 전송되지 않거나 실패된 현금영수증을 삭제합니다.
※ 삭제 가능한 상태: "임시저장", "발행취소", "역발행거부", "역발행취소", "전송실패"
def delete(corpNum, mgtKey, userID = '')
ㆍ삭제처리된 현금영수증의 문서번호는 재사용이 가능합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ취소 현금영수증을 발행하며 취소 현금영수증의 금액은 원본 금액을 넘을 수 없습니다. [참고] 팝빌 국세청 전송 정책
※ 발행된 취소 현금영수증의 상태는 "발행완료" 입니다.
ㆍ"발행완료"된 취소 현금영수증은 국세청 전송 이전에 [1.3 CancelIssue – 발행취소] 함수로 국세청 신고 대상에서 제외할 수 있습니다.
def revokeRegistIssue(corpNum, mgtKey, orgConfirmNum, orgTradeDate, smssendYN = false, memo = "", userID = "", isPartCancel = false, cancelType = nil, supplyCost = nil, tax = nil, serviceFee = nil, totalAmount = nil)
ㆍ원본 현금영수증의 국세청 승인번호와 거래일자는 상태 확인(GetInfo)함수를 통해 확인 가능합니다.
ㆍ취소 현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O |
파트너가 할당한 문서번호
※ 영문, 숫자, 하이픈('-')을 이용하여 24자리 이하의 고유한 값 할당 |
3 | orgConfirmNum | String | 9 | O |
원본 현금영수증의 국세청 승인번호
└ [2.1. GetInfo – 상태확인]의 리턴값 'CashbillInfo'의 변수 'confirmNum'를 통해 내용 확인 가능 |
4 | orgTradeDate | String | 8 | O |
원본 현금영수증의 거래일자 (형식 : yyyyMMdd)
└ [2.1. GetInfo – 상태확인]의 리턴값 'CashbillInfo'의 변수 '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 = 기타 ※ 미입력시 기본값 1 처리 |
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 인 경우 미입력 |
Return
Throws
ㆍ현금영수증 1건의 상태 및 요약정보를 확인합니다.
ㆍ리턴값 'CashbillInfo'의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다. [참고] 현금영수증 상태코드
def getInfo(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ다수건의 현금영수증의 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
ㆍ리턴값 'CashbillInfo'의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다. [참고] 현금영수증 상태코드
def getInfos(corpNum, mgtKeyList, userID = '')
ㆍ문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKeyList | Array | 1000 | O | [배열] 조회할 현금영수증 문서번호 (최대 1,000건) |
6 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ현금영수증 1건의 상세정보를 확인합니다.
def getDetailInfo(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ파트너가 지정한 검색조건에 해당하는 현금영수증를 조회합니다.
def search(corpNum, dType, sDate, eDate, state, tradeType, tradeUsage, taxationType, page, perPage, order, queryString = '', userID = '', tradeOpt = '')
ㆍ페이지 관련 항목(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 | Array | - | O |
[배열] 현금영수증 상태코드
└ 상태코드 2,3번째 자리에 와일드카드(*) 사용가능, 예) "1**", "3**" [참고] "현금영수증 상태코드" |
6 | tradeType | Array | - | O |
[배열] 현금영수증 문서형태 : "N" / "C" 중 선택 (다중 선택 가능)
└ N = 일반 현금영수증, C = 취소 현금영수증 |
7 | tradeUsage | Array | - | O |
[배열] 거래구분 : "P" / "C" 중 선택 (다중 선택 가능)
└ P = 소득공제용, C = 지출증빙용 |
8 | taxationType | Array | - | O |
[배열] 과세형태 : "T" / "N" 중 선택 (다중 선택 가능)
└ T = 과세, N = 비과세 |
9 | page | Integer | - | O | 목록 페이지번호 (기본값 1) |
10 | perPage | Integer | - | O | 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) |
11 | order | String | 1 | O |
{@no.2 DType} 값을 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순 |
12 | queryString | String | - | - |
현금영수증 식별번호 조회
※ 미입력시 전체조회 |
13 | userID | String | 50 | - | 팝빌회원 아이디 |
14 | tradeOpt | Array | - | - |
[배열] 거래유형 : "N" / "B" / "T" 중 선택 (다중 선택 가능)
└ N = 일반, B = 도서공연, T = 대중교통 |
Return
Throws
ㆍ현금영수증의 상태에 대한 변경이력을 확인합니다.
def getLogs(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ로그인 상태로 팝빌 사이트의 현금영수증 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getURL(corpNum, togo, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | togo | String | - | O |
접근 메뉴 : "TBOX" / "PBOX" / "WRITE" 중 택 1
└ TBOX = 임시 문서함, PBOX = 발행 문서함, WRITE = 현금영수증 작성 중 택 1 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ팝빌 사이트와 동일한 현금영수증 1건의 상세 정보 페이지의 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPopUpURL(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ현금영수증 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPrintURL(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ다수건의 현금영수증을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다. (최대 100건)
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getMassPrintURL(corpNum, mgtKeyList, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKeyList | Array | 100 | O | [배열] 인쇄할 현금영수증 문서번호 (최대 100건) |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ구매자가 수신하는 현금영수증 안내 메일의 하단에 버튼 URL 주소를 반환합니다.
ㆍ함수 호출로 반환 받은 URL에는 유효시간이 없습니다.
def getMailURL(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ현금영수증 PDF 파일을 다운 받을 수 있는 URL을 반환합니다.
ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.
def getPDFURL(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getAccessURL(corpNum, userID)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ현금영수증과 관련된 안내 메일을 재전송 합니다.
def sendEmail(corpNum, mgtKey, receiverMail, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 이메일 재전송할 현금영수증 문서번호 |
3 | receiverMail | String | - | O | 수신자 이메일주소 |
4 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ현금영수증과 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인 할 수 있습니다.
ㆍ메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
def sendSMS(corpNum, mgtKey, senderNum, receiverNum, contents, userID = '')
ㆍ함수 호출시 포인트가 과금됩니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | senderNum | String | - | O | 발신번호 |
4 | receiverNum | String | - | O | 수신번호 |
5 | contents | String | 90 | O |
메시지 내용
※ 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송 |
6 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ현금영수증을 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인 할 수 있습니다.
def sendFax(corpNum, mgtKey, senderNum, receiverNum, userID = '')
ㆍ함수 호출시 포인트가 과금됩니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
3 | senderNum | String | - | O | 발신번호 |
4 | receiverNum | String | - | O | 수신번호 |
5 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동 시스템에서 현금영수증을 관리하기 위해 팝빌 사이트를 통해 생성한 현금영수증에 문서번호를 할당합니다.
def assignMgtKey(corpNum, itemKey, mgtKey, userID = '')
ㆍ팝빌 사이트를 통해 생성한 현금영수증에는 문서번호가 할당되어 있지 않습니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | itemKey | String | 24 | O |
팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
└ 함수 [2.4. Search – 목록 조회]를 통하여 CashbillInfo의 'itemKey'를 확인 |
3 | mgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
4 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ현금영수증 관련 메일 항목에 대한 발송설정을 확인합니다.
def listEmailConfig(corpNum, userID ='')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ현금영수증 관련 메일 항목에 대한 발송설정을 수정합니다.
def updateEmailConfig(corpNum, emailType, sendYN, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | emailType | String | - | O |
* 발송 메일 유형
CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일 CSH_CANCEL : 고객에게 현금영수증이 발행취소 되었음을 알려주는 메일 |
3 | sendYN | Boolean | - | O | 전송 여부 |
4 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동회원의 잔여포인트를 확인합니다.
def getBalance(corpNum)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
Return
Float - 연동회원 잔여포인트
Throws
ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getChargeURL(corpNum, userID)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ파트너의 잔여포인트를 확인합니다.
def getPartnerBalance(corpNum)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
Return
Float - 파트너 잔여포인트
Throws
ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPartnerURL(corpNum, togo)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | togo | String | - | O | "CHRG" 입력 |
Return
String - 요청에 대한 응답 URL
Throws
ㆍ현금영수증 발행시 과금되는 포인트 단가를 확인합니다.
def getUnitCost(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Float - 현금영수증 발행단가
Throws
ㆍ팝빌 현금영수증 API 서비스 과금정보를 확인합니다.
def getChargeInfo(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.
def checkIsMember(corpNum, linkID)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | linkID | String | - | O | 연동신청시 팝빌에서 발급받은 링크아이디 |
Return
Throws
ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.
def checkID(idValue)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | idValue | String | 20 | O | 중복여부를 확인할 아이디 |
Return
Response - code : 0 (미사용중) / code : 1 (사용중)
Throws
ㆍ사용자를 연동회원으로 가입처리합니다.
def joinMember(joinInfo)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | joinInfo | JoinForm | - | O | 연동회원 객체정보 |
Return
Throws
ㆍ연동회원의 회사정보를 확인합니다.
def getCorpInfo(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동회원의 회사정보를 수정합니다.
def updateCorpInfo(corpNum, corpInfo, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | corpInfo | CorpInfo | - | O | 회사 객체정보 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.
def registContact(corpNum, contactInfo, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | contactInfo | ContactInfo | - | O | 담당자 객체정보 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.
def listContact(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.
def updateContact(corpNum, contactInfo, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
1 | corpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
2 | contactInfo | ContactInfo | - | O | 담당자 객체정보 |
3 | userID | String | 50 | - | 팝빌회원 아이디 |
Return
Throws
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | code | 코드 | Integer | - | API 처리에 대한 응답코드 |
2 | message | 메시지 | String | - | API 처리에 대한 응답메시지 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | code | 코드 | Integer | - |
API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드 |
2 | message | 메시지 | String | - | API 처리 실패에 대한 오류메시지 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|---|
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 | tradeType | 문서형태 | String | 4 | O | "승인거래" / "취소거래" 중 택 1 |
7 | tradeUsage | 거래구분 | String | - | O | "소득공제용" / "지출증빙용" 중 택 1 |
8 | tradeOpt | 거래유형 | String | 4 | - |
"일반" / "도서공연" / "대중교통" 중 택 1
※ 미입력시 기본값 "일반" 처리 |
9 | taxationType | 과세형태 | String | - | O | "과세" / "비과세" 중 택 1 |
10 | totalAmount | 거래금액 | String | 9 | O | 양수만 입력 |
11 | supplyCost | 공급가액 | String | 9 | O | 양수만 입력 |
12 | tax | 부가세 | String | 9 | O | 양수만 입력 |
13 | serviceFee | 봉사료 | String | 9 | O | 양수만 입력 |
14 | franchiseCorpNum | 가맹점 사업자번호 | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) |
15 | franchiseCorpName | 가맹점 상호 | String | 200 | - | |
16 | franchiseCEOName | 가맹점 대표자 성명 | String | 100 | - | |
17 | franchiseAddr | 가맹점 주소 | String | 400 | - | |
18 | franchiseTEL | 가맹점 전화번호 | String | 20 | - | |
19 | identityNum | 식별번호 | String | 19 | O |
{@no.7 tradeUsage} 값이 "소득공제용" 인 경우
└ 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 입력 {@no.7 tradeUsage} 값이 "지출증빙용" 인 경우 └ 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 입력 ※ 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능 |
20 | customerName | 구매자(고객) 성명 | String | 70 | - | |
21 | itemName | 주문 상품명 | String | 70 | - | |
22 | orderNumber | 주문번호 | String | 200 | - | |
23 | 구매자(고객) 이메일 | String | 100 | - | ||
24 | hp | 구매자(고객) 휴대폰 | String | 20 | - | {@no.25 smssendYN} 값이 true 인 경우 이 값으로 안내 문자 전송 |
25 | smssendYN | SMS 전송여부 | Boolean | - | - |
true : (전송) / false : (미전송)
※ 미입력시 기본값 false 처리 |
26 | faxsendYN | FAX 전송여부 | Boolean | - | - |
true : (전송) / false : (미전송)
※ 미입력시 기본값 false 처리 |
27 | cancelType | 취소사유 | Integer | 1 | - |
null : (일반 현금영수증) / 1 : (거래취소) / 2 : (오류발급취소) / 3 : (기타) 중 택 1
※ 취소 현금영수증 발행시 미입력하면 기본값 1 처리 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | code | 코드 | Integer | - | API 처리에 대한 응답코드 |
2 | message | 메시지 | String | - | API 처리에 대한 응답메시지 |
3 | total | 총 검색결과 건수 | Integer | - | |
4 | perPage | 페이지당 검색개수 | Integer | - | |
5 | pageNum | 페이지 번호 | Integer | - | |
6 | pageCount | 페이지 개수 | Integer | - | |
7 | list | 현금영수증 상태/요약정보 | CashbillInfo[ ] |
[배열] 최대 1,000건
└ 함수 [2.1. GetInfo - 상태 확인]의 리턴값 구성과 동일 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | itemKey | 팝빌번호 | String | 18 | 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호 |
2 | mgtKey | 문서번호 | String | 24 | 현금영수증 관리를 위해 파트너가 할당하는 식별번호 |
3 | tradeDate | 거래일자 | String | 8 | 형식 : yyyyMMdd |
4 | tradeType | 문서형태 | String | 4 | "승인거래" / "취소거래" 중 반환 |
5 | tradeUsage | 거래구분 | String | 5 | "소득공제용" / "지출증빙용" 중 반환 |
6 | tradeOpt | 거래유형 | String | 4 | "일반" / "도서공연" / "대중교통" 중 반환 |
7 | taxationType | 과세형태 | String | 3 | "과세" / "비과세" 중 반환 |
8 | totalAmount | 거래금액 | String | 9 | |
9 | issueDT | 발행일시 | String | 14 | 형식 : yyyyMMddHHmmss |
10 | regDT | 등록일시 | String | 14 | 형식 : yyyyMMddHHmmss |
11 | stateMemo | 상태메모 | String | 200 | |
12 | stateCode | 상태코드 | Integer | 3 | [참고] 현금영수증 상태코드 |
13 | stateDT | 상태변경일시 | String | 14 | 형식 : yyyyMMddHHmmss |
14 | identityNum | 식별번호 | String | 19 |
{@no.5 tradeUsage} 값이 "소득공제용" 인 경우
└ 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 반환 {@no.5 tradeUsage} 값이 "지출증빙용" 인 경우 └ 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 반환 |
15 | itemName | 주문상품명 | String | 70 | |
16 | customerName | 구매자(고객) 성명 | String | 70 | |
17 | confirmNum | 국세청 승인번호 | String | 9 | 국세청 전송 시점에 팝빌에서 자동으로 부여 |
18 | orgConfirmNum | 원본 현금영수증 국세청 승인번호 |
String | 9 | {@no.4 tradeType} 값이 "취소거래"인 경우만 존재 |
19 | orgTradeDate | 원본 현금영수증 거래일자 | String | 8 | {@no.4 tradeType} 값이 "취소거래"인 경우만 존재 |
20 | ntssendDT | 국세청 전송일시 | String | 14 | 형식 : yyyyMMddHHmmss |
21 | ntsresultDT | 국세청 처리결과 수신일시 | String | 14 | 형식 : yyyyMMddHHmmss |
22 | ntsresultCode | 국세청 처리결과 상태코드 | String | 4 | [참고] 국세청 전송 결과코드 |
23 | ntsresultMessage | 국세청 처리결과 메시지 | String | 30 | |
24 | printYN | 인쇄여부 | Boolean | - | true : (인쇄) / false : (미인쇄) 중 반환 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | docLogType | 로그타입 | Integer | 3 |
100 : (임시저장) / 111 : (메일 재전송) / 112 : (문자 재전송) / 113 : (팩스 재전송)
122 : (문자 전송결과) / 123 : (팩스 전송결과) 410 : (발행) / 411 : (발행취소) / 451 : (전송 대기전) 452 : (전송 진행중) / 453 : (국세청 전송 접수) 454 : (전송완료) / 455 : (전송실패) 중 반환 |
2 | log | 이력정보 | String | 2000 | |
3 | procType | 처리형태 | String | 3 | "연동" : (API로 처리함) / "일반" : (팝빌 사이트에서 처리함) / "시스템" : (팝빌이 처리함) 중 반환 |
4 | procMemo | 처리메모 | String | 200 | |
5 | regDT | 등록일시 | String | 14 | 형식 : yyyyMMddHHmmss |
6 | ip | 아이피 | String | 39 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | emailType | 메일전송유형 | String | - |
CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일
|
2 | sendYN | 전송여부 | Boolean | - | true : (전송) / false : (미전송) 중 반환 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 비고 |
---|---|---|---|---|---|
1 | unitCost | 발행단가 | String | - | |
2 | chargeMethod | 과금유형 | String | - | "연동" / "파트너" 중 반환 |
3 | rateSystem | 과금제도 | String | - | "종량제" 반환 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|---|
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 | - |
순번 | 변수명 | 항목명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|---|
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 |
순번 | 변수명 | 항목명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|---|
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 | 담당자 이메일 | 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 : (사용중) 중 반환 |