A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 |
IssueResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
confirmNum | str | 9 |
국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 |
|
tradeDate | str | 8 |
거래일자 (형식 : yyyyMMdd)
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - |
API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드 |
|
message | str | - | API 처리 실패에 대한 오류메시지 |
Cashbill
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
mgtKey | str | 24 | Y |
문서번호
└ 현금영수증 관리를 위해 파트너가 할당하는 식별번호 └ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|
confirmNum | str | 9 | X |
국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 |
|
orgConfirmNum | str | 9 | 조건부 |
원본 현금영수증 국세청 승인번호
└ 취소 현금영수증 작성시 필수 |
|
orgTradeDate | str | 9 | 조건부 |
원본 현금영수증 거래일자
└ 취소 현금영수증 작성시 필수 |
|
tradeDate | str | 8 | X |
현금영수증 발행 시점에 팝빌에서 자동으로 부여
└ {tradeDT}의 yyyyMMdd ※ 거래일자는 입력 할 수 없음 |
|
tradeDT | str | 14 | N |
거래일시 (형식 : yyyyMMddHHmmss)
└ 전날부터 당일까지 입력가능 ※ 미입력시 기본값 발행일시 처리 |
|
tradeType | str | 4 | Y |
문서형태 : "승인거래" / "취소거래" 중 입력
└ "승인거래" 현금영수증은 [RegistIssue - 즉시 발행]함수 사용하여 발행 └ "취소거래" 현금영수증은 [RevokeRegistIssue - 취소 현금영수증 즉시 발행]함수 사용하여 발행 |
|
tradeUsage | str | - | Y | 거래구분 : "소득공제용" / "지출증빙용" 중 택 1 | |
tradeOpt | str | 4 | N |
거래유형 : "일반" / "도서공연" / "대중교통" 중 택 1
└ 미입력시 기본값 "일반" 처리 |
|
taxationType | str | - | Y | "과세" / "비과세" 중 택 1 | |
totalAmount | str | 9 | Y | 거래금액 └ 양수만 입력 |
|
supplyCost | str | 9 | Y | 공급가액 └ 양수만 입력 |
|
tax | str | 9 | Y | 부가세 └ 양수만 입력 |
|
serviceFee | str | 9 | Y | 봉사료 └ 양수만 입력 |
|
franchiseCorpNum | str | 10 | Y | 가맹점 사업자번호 └ 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
franchiseTaxRegID | str | 4 | N | 가맹점 종사업장 식별번호 └ 4자리 숫자값 |
|
franchiseCorpName | str | 200 | N | 가맹점 상호 | |
franchiseCEOName | str | 100 | N | 가맹점 대표자 성명 | |
franchiseAddr | str | 400 | N | 가맹점 주소 | |
franchiseTEL | str | 20 | N | 가맹점 전화번호 | |
identityNum | str | 19 | Y |
식별번호
└ {tradeUsage} 값이 "소득공제용" 인 경우 └ 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 입력 {tradeUsage} 값이 "지출증빙용" 인 경우 └ 사업자번호/휴대폰/카드번호 입력 ※ 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능 |
|
customerName | str | 70 | N | 구매자명 | |
itemName | str | 70 | N | 주문상품명 | |
orderNumber | str | 200 | N | 주문번호 | |
str | 100 | N | 구매자(고객) 이메일 | ||
hp | str | 20 | N |
구매자(고객) 휴대폰
└ {smssendYN} 값이 True 인 경우 이 값으로 안내 문자 전송 |
|
smssendYN | bool | - | N |
SMS 전송여부 True : (전송) / False : (미전송) 중 택1
※ 미입력시 기본값 False처리 |
|
faxsendYN | bool | - | N |
FAX 전송여부 : True / False 중 택1
└ True : 전송 └ False : 미전송 ※ 미입력시 기본값 False처리 |
|
cancelType | int | 1 | N |
취소사유
└ None : (일반 현금영수증) └ 1 : (거래취소) └ 2 : (오류발급취소) └ 3 : (기타) 중 택 1 └ 취소 현금영수증 발행시 미입력하면 기본값 1 처리 |
BulkResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
receiptID | str | 24 |
접수아이디
└ 접수 시점에 팝빌에서 자동으로 부여 |
BulkCashbillResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
submitID | str | 36 | 접수 시점에 고객사에서 부여한 제출아이디 | |
submitCount | int | - | 현금영수증 접수 건수 | |
successCount | int | - | 현금영수증 발행 성공 건수 | |
failCount | int | - | 현금영수증 발행 실패 건수 | |
txState | int | 1 |
접수상태 : 0 / 1 / 2 중 반환
└ 0 : 접수 └ 1 : 처리중 └ 2 : 처리완료 |
|
txResultCode | int | - | 접수 결과코드 | |
txStartDT | str | 14 | 발행처리 시작일시 (형식 : yyyyMMddHHmmss) | |
txEndDT | str | 14 | 발행처리 완료일시 (형식 : yyyyMMddHHmmss) | |
receiptDT | str | 14 | 접수일시 (형식 : yyyyMMddHHmmss) | |
issueResult | BulkCashbillIssueResult[ ] | 발행결과 | ||
receiptID | str | 36 |
접수아이디
└ 접수 시점에 팝빌에서 자동으로 부여 |
BulkCashbillIssueResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
mgtKey | str | 24 | 문서번호 | |
confirmNum | str | 9 |
국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 |
|
tradeDate | str | 8 |
거래일자 (형식 : yyyyMMdd)
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 ※ 미입력시 기본값 발행일시 처리 |
|
issueDT | str | 14 | 발행일시 (형식 : yyyyMMddHHmmss) |
CBSearchResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
total | int | - | 총 검색결과 건수 | |
perPage | int | - | 페이지당 검색개수 | |
pageNum | int | - | 페이지 번호 | |
pageCount | int | - | 페이지 개수 | |
list | CashbillInfo[ ] |
현금영수증 상태/요약정보 (최대 1,000건)
└ 함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일 |
CashbillInfo
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
itemKey | str | 18 | 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호 | |
mgtKey | str | 24 | 현금영수증 관리를 위해 파트너가 할당하는 식별번호 | |
tradeDate | str | 8 | 거래일자 (형식 : yyyyMMdd) | |
tradeDT | str | 14 | 거래일시 (형식 : yyyyMMddHHmmss) | |
tradeType | str | 4 | "승인거래" / "취소거래" 중 반환 | |
tradeUsage | str | 5 | "소득공제용" / "지출증빙용" 중 반환 | |
tradeOpt | str | 4 | "일반" / "도서공연" / "대중교통" 중 반환 | |
taxationType | str | 3 | "과세" / "비과세" 중 반환 | |
totalAmount | str | 9 | 거래금액 | |
issueDT | str | 14 | 발행일시 (형식 : yyyyMMddHHmmss) | |
regDT | str | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
stateCode | int | 3 |
상태코드
└ [참고] 팝빌 상태코드 |
|
stateDT | str | 14 | 상태 변경일시 (형식 : yyyyMMddHHmmss) | |
identityNum | str | 19 |
식별번호
└ {tradeUsage} 값이 "소득공제용" 인 경우 └ 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 └ {tradeUsage} 값이 "지출증빙용" 인 경우 └ 사업자번호/휴대폰/카드번호 반환 |
|
itemName | str | 70 | 주문상품명 | |
customerName | str | 70 | 구매자(고객) 성명 | |
confirmNum | str | 9 |
국세청 승인번호
└ 현금영수증 발행 시점에 팝빌에서 자동으로 부여 |
|
orgConfirmNum | str | 9 | {tradeType} 값이 "취소거래"인 경우만 존재 | |
orgTradeDate | str | 8 | {tradeType} 값이 "취소거래"인 경우만 존재 | |
ntssendDT | str | 14 | 국세청 전송일시 (형식 : yyyyMMddHHmmss) | |
ntsresultDT | str | 14 | 국세청 처리결과 수신일시 (형식 : yyyyMMddHHmmss) | |
ntsresultCode | str | 4 |
결과코드
└ [참고] 국세청 결과코드 |
|
ntsresultMessage | str | 30 | 국세청 처리결과 메시지 | |
printYN | bool | - | 인쇄여부 : True / False 중 반환 | |
interOPYN | boolean | - |
연동문서 여부 : true / false 중 반환
└ true : API를 통해 발행한 연동문서 └ false : 팝빌 사이트를 통해 발행한 문서 |
EmailSendConfig
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
emailType | str | 9 |
메일전송유형
|
|
sendYN | bool | - |
전송여부 : True / False 중 반환
└ True : 전송 └ False : 미전송 |
UseHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
total | int | - | 총 검색결과 건수 | |
perPage | int | - | 페이지당 검색개수 | |
pageNum | int | - | 페이지 번호 | |
pageCount | int | - | 페이지 개수 | |
list | UseHistory[] | 사용내역 |
UseHistory
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
itemCode | str | 3 | 서비스 코드
|
|
txType | str | 2 | 포인트 증감 유형
포인트 증가
포인트 감소
|
|
txPoint | str | 18 | 증감 포인트 | |
balance | str | 18 | 잔여포인트 | |
txDT | str | 14 | 포인트 증감 일시 (형식 : yyyyMMddHHmmss) | |
userID | str | 50 | 담당자 아이디 | |
userName | str | 100 | 담당자명 |
PaymentHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
total | int | - | 총 검색결과 건수 | |
perPage | int | - | 페이지당 검색개수 | |
pageNum | int | - | 페이지 번호 | |
pageCount | int | - | 페이지 개수 | |
list | PaymentHistory[] | 결제내역 |
PaymentHistory
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
productType | str | 3 | 결제 내용 : "포인트" / "정액제" / "미수금" 중 반환 | |
productName | str | 30 | 결제 상품명 | |
settleType | str | 7 | 결제유형 : "무통장" / "신용카드" / "실시간계좌이체" 중 반환 | |
settlerName | str | 100 | 담당자명 | |
settlerEmail | str | 100 | 담당자메일 | |
settleCost | str | 18 | 결제금액 | |
settlePoint | str | 18 | 충전포인트 | |
settleState | int | 1 |
결제상태 : 1 / 2 / 3 / 4 / 5 중 반환
└ 1 : 대기 └ 2 : 승인 └ 3 : 실패 └ 4,5 : 취소 |
|
regDT | str | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
stateDT | str | 14 | 상태일시 (형식 : yyyyMMddHHmmss) |
RefundHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
total | int | - | 총 검색결과 건수 | |
perPage | int | - | 페이지당 검색개수 | |
pageNum | int | - | 페이지 번호 | |
pageCount | int | - | 페이지 개수 | |
list | RefundHistory[] | 환불내역 |
RefundHistory
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
reqDT | str | 14 | 신청일시 (형식 : yyyyMMddHHmmss) | |
requestPoint | str | 18 | 환불 신청포인트 | |
accountBank | str | 10 | 환불계좌 은행명 | |
accountNum | str | 50 | 환불계좌번호 | |
accountName | str | 70 | 환불계좌 예금주명 | |
state | int | 1 |
상태
└ 1 : 접수대기 └ 2 : 심사중 └ 3 : 입금대기 └ 4 : 환불완료 └ 5 : 취소 |
|
reason | str | 200 | 환불사유 |
RefundForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
ContactName | str | 100 | Y | 담당자명 | |
tel | str | 20 | Y | 담당자 연락처 | |
RequestPoint | str | 18 | Y | 환불 신청 포인트 | |
AccountBank | str | 10 | Y | 은행명 | |
AccountNum | str | 50 | Y | 계좌번호 | |
AccountName | str | 70 | Y | 예금주명 | |
Reason | str | 200 | N | 환불사유 |
PaymentForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
settlerName | str | 100 | N | 담당자명 | |
settlerEmail | str | 100 | N | 담당자 이메일 | |
notifyHP | str | 20 | N |
담당자 휴대폰
└ 무통장 입금 승인 알림톡이 전송될 번호 |
|
paymentName | str | 70 | Y | 입금자명 | |
settleCost | str | 18 | Y | 결제금액 |
PaymentResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | 응답코드 | |
message | str | - | 응답메시지 | |
settleCode | str | 18 | 정산코드 |
ChargeInfo
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
unitCost | str | 12 | 발행단가 | |
chargeMethod | str | 3 | 과금유형 : "연동" / "파트너" 중 반환 | |
rateSystem | str | 3 | 과금제도 : "종량제" 반환 |
JoinForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
ID | str | 50 | Y |
아이디
└ 6자 이상 50자 이하 |
|
Password | str | 20 | Y |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
LinkID | str | 20 | Y |
파트너 링크아이디
└ 연동신청시 팝빌에서 발급받은 링크아이디 |
|
CorpNum | str | 10 | Y |
사업자번호
└ 하이픈 '-' 제외 10자리 숫자값 |
|
CEOName | str | 100 | Y | 대표자 성명 | |
CorpName | str | 200 | Y | 회사명 | |
Addr | str | 300 | Y | 사업장 주소 | |
BizType | str | 100 | Y | 업태 | |
BizClass | str | 100 | Y | 종목 | |
ContactName | str | 100 | Y | 담당자 성명 | |
ContactEmail | str | 100 | Y | 담당자 이메일 | |
ContactTEL | str | 20 | Y | 담당자 휴대폰 |
CorpInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
ceoname | str | 100 | Y | 대표자 성명 | |
corpName | str | 200 | Y | 회사명 | |
addr | str | 300 | Y | 주소 | |
bizType | str | 100 | Y | 업태 | |
bizClass | str | 100 | Y | 종목 |
ContactInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
id | str | 50 | Y |
아이디
└ 6자 이상 50자 이하 |
|
Password | str | 20 | 조건부 |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
personName | str | 100 | Y | 담당자 성명 | |
tel | str | 20 | Y | 담당자 휴대폰 | |
str | 100 | Y | 담당자 이메일 | ||
regDT | str | 14 | X | 등록일시 (형식 : yyyyMMddHHmmss) | |
searchRole | int | 1 | N |
담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한 └ 2 : 읽기권한 └ 3 : 회사권한 |
|
mgrYN | bool | - | X |
관리자 여부 : True / False 중 반환
└ True : 관리자 └ False : 담당자 └ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능 |
|
state | int | 1 | X |
계정상태 : 1 반환
└ 1 : 사용중 |
RefundResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | int | - | API 처리에 대한 응답코드 | |
message | str | - | API 처리에 대한 응답메시지 | |
refundCode | str | 18 | 환불코드 |