A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 |
IssueResponse
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 | |
invoiceNum | string | 24 |
팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당
|
PopbillException
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
message | string | - | API 처리 실패에 대한 오류메시지 |
Statement - 입력부
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
itemCode | number | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
mgtKey | string | 24 | Y |
문서번호
전자명세서 관리를 위해 파트너가 할당하는 식별번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|
formCode | string | 8 | N |
맞춤양식 코드
기본값 : 팝빌에서 설정한 기본양식 사용
|
|
writeDate | string | 8 | Y |
작성일자
형식 : yyyyMMdd
|
|
taxType | string | 2 | 조건부 |
과세형태 (택 1)
과세
영세
면세
{itemCode}=121 경우 필수
|
|
purposeType | string | - | Y |
결제대금 수취여부 (택 1)
영수
청구
없음
|
|
serialNum | string | 30 | N | 일련번호 | |
taxTotal | string | 18 | Y |
세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
supplyCostTotal | string | 18 | Y |
공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
totalAmount | string | 18 | N |
합계금액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
remark1 | string | 150 | N | 비고 1 | |
remark2 | string | 150 | N | 비고 2 | |
remark3 | string | 150 | N | 비고 3 | |
senderCorpNum | string | 10 | Y | 발신자 사업자번호 ('-' 제외) | |
senderTaxRegID | string | 4 | N |
발신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
senderCorpName | string | 200 | N | 발신자 상호 | |
senderCEOName | string | 100 | N | 발신자 대표자성명 | |
senderAddr | string | 300 | N | 발신자 주소 | |
senderBizType | string | 100 | N | 발신자 업태 | |
senderBizClass | string | 100 | N | 발신자 종목 | |
senderContactName | string | 100 | N | 발신자 성명 | |
senderDeptName | string | 40 | N | 발신자 부서명 | |
senderTEL | string | 20 | N | 발신자 연락처 | |
senderHP | string | 20 | N | 발신자 휴대전화 | |
senderEmail | string | 100 | N | 발신자 이메일주소 | |
senderFAX | string | 20 | N | 발신자 팩스번호 | |
receiverCorpNum | string | 10 | Y | 수신자 사업자번호 ('-' 제외) | |
receiverTaxRegID | string | 4 | N |
수신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
receiverCorpName | string | 200 | Y | 수신자 상호 | |
receiverCEOName | string | 100 | N | 수신자 대표자성명 | |
receiverAddr | string | 300 | N | 수신자 주소 | |
receiverBizType | string | 100 | N | 수신자 업태 | |
receiverBizClass | string | 100 | N | 수신자 종목 | |
receiverContactName | string | 100 | Y | 수신자 성명 | |
receiverDeptName | string | 40 | N | 수신자 부서명 | |
receiverTEL | string | 20 | N | 수신자 연락처 | |
receiverHP | string | 20 | N | 수신자 휴대전화 | |
receiverEmail | string | 100 | N | 수신자 이메일주소 | |
receiverFAX | string | 20 | N | 수신자 팩스번호 | |
propertyBag | object | - | N |
추가속성
전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력
[참고] 기본양식 추가속성
|
|
businessLicenseYN | boolean | - | N |
팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
|
|
bankBookYN | boolean | - | N |
팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
|
|
smssendYN | boolean | - | N |
알림문자 전송 여부
true전송
false미전송 : 기본값
수신자 : 수신자 휴대폰번호 {receiverHP}
문자 전송 포인트가 차감(단, 전송실패 건은 환불) |
|
detailList | StatementDetail[] | N |
거래 물품 상세정보
길이 제한 없음
|
Statement - 출력부
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
itemCode | number | 3 |
전자명세서 문서유형
|
|
mgtKey | string | 24 |
문서번호
전자명세서 관리를 위해 파트너가 할당하는 식별번호
|
|
invoiceNum | string | 24 |
팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당
|
|
formCode | string | 8 | 맞춤양식 코드 | |
writeDate | string | 8 |
작성일자
형식 : yyyyMMdd
|
|
taxType | string | 2 |
과세형태
과세
영세
면세
{itemCode}=121 경우 반환
|
|
purposeType | string | - |
결제대금 수취여부
영수
청구
없음
|
|
serialNum | string | 30 | 일련번호 | |
taxTotal | string | 18 | 세액 합계 | |
supplyCostTotal | string | 18 | 공급가액 합계 | |
totalAmount | string | 18 | 합계금액 | |
remark1 | string | 150 | 비고 1 | |
remark2 | string | 150 | 비고 2 | |
remark3 | string | 150 | 비고 3 | |
senderCorpNum | string | 10 | 발신자 사업자번호 ('-' 제외) | |
senderTaxRegID | string | 4 |
발신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
senderCorpName | string | 200 | 발신자 상호 | |
senderCEOName | string | 100 | 발신자 대표자성명 | |
senderAddr | string | 300 | 발신자 주소 | |
senderBizType | string | 100 | 발신자 업태 | |
senderBizClass | string | 100 | 발신자 종목 | |
senderContactName | string | 100 | 발신자 성명 | |
senderDeptName | string | 40 | 발신자 부서명 | |
senderTEL | string | 20 | 발신자 연락처 | |
senderHP | string | 20 | 발신자 휴대전화 | |
senderEmail | string | 100 | 발신자 이메일주소 | |
senderFAX | string | 20 | 발신자 팩스번호 | |
receiverCorpNum | string | 10 | 수신자 사업자번호 ('-' 제외) | |
receiverTaxRegID | string | 4 |
수신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
receiverCorpName | string | 200 | 수신자 상호 | |
receiverCEOName | string | 100 | 수신자 대표자성명 | |
receiverAddr | string | 300 | 수신자 주소 | |
receiverBizType | string | 100 | 수신자 업태 | |
receiverBizClass | string | 100 | 수신자 종목 | |
receiverContactName | string | 100 | 수신자 성명 | |
receiverDeptName | string | 40 | 수신자 부서명 | |
receiverTEL | string | 20 | 수신자 연락처 | |
receiverHP | string | 20 | 수신자 휴대전화 | |
receiverEmail | string | 100 | 수신자 이메일주소 | |
receiverFAX | string | 20 | 수신자 팩스번호 | |
propertyBag | object | - |
추가속성
전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력
[참고] 기본양식 추가속성
|
|
businessLicenseYN | boolean | - |
팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부
|
|
bankBookYN | boolean | - |
팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부
|
|
smssendYN | boolean | - |
알림문자 전송 여부
true전송
false미전송
수신자 : 수신자 휴대폰번호 {receiverHP}
|
|
detailList | StatementDetail[] |
거래 물품 상세정보
길이 제한 없음
|
StatementDetail
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
serialNum | number | - | Y |
일련번호
1부터 순차적으로 입력
|
|
purchaseDT | string | 8 | N |
거래일자
형식 : yyyyMMdd
|
|
itemName | string | 100 | N | 품명 | |
spec | string | 60 | N | 규격 | |
qty | string | 12 | N |
수량
소수점 아래 2번째 자리까지 입력 가능
|
|
unitCost | string | 18 | N |
단가
소수점 아래 2번째 자리까지 입력 가능
마이너스 금액 입력 가능 |
|
supplyCost | string | 18 | N |
공급가액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
tax | string | 18 | N |
세액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
remark | string | 100 | N | 비고 | |
spare1 | string | 100 | N | 여분1 | |
spare2 | string | 100 | N | 여분2 | |
spare3 | string | 100 | N | 여분3 | |
spare4 | string | 100 | N | 여분4 | |
spare5 | string | 100 | N | 여분5 | |
spare6 | string | 100 | N | 여분6 | |
spare7 | string | 100 | N | 여분7 | |
spare8 | string | 100 | N | 여분8 | |
spare9 | string | 100 | N | 여분9 | |
spare10 | string | 100 | N | 여분10 | |
spare11 | string | 100 | N | 여분11 | |
spare12 | string | 100 | N | 여분12 | |
spare13 | string | 100 | N | 여분13 | |
spare14 | string | 100 | N | 여분14 | |
spare15 | string | 100 | N | 여분15 | |
spare16 | string | 100 | N | 여분16 | |
spare17 | string | 100 | N | 여분17 | |
spare18 | string | 100 | N | 여분18 | |
spare19 | string | 100 | N | 여분19 | |
spare20 | string | 100 | N | 여분20 |
StmtSearchResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 | |
total | string | - | 총 검색결과 건수 | |
perPage | string | - | 페이지당 목록 건수 | |
pageNum | string | - | 페이지 번호 | |
pageCount | string | - | 페이지 개수 | |
list | StatementInfo[] |
전자명세서 상태/요약정보
함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일
최대 1,000건 |
StatementInfo
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
itemCode | number | 3 |
전자명세서 문서유형
|
|
itemKey | string | 18 |
팝빌번호
팝빌에서 전자명세서 관리 목적으로 할당한 식별번호
|
|
invoiceNum | string | 24 |
팝빌 승인번호
전자명세서 발행 시점에 팝빌에서 자동으로 할당
|
|
mgtKey | string | 24 | 파트너가 할당한 문서번호 | |
taxType | string | 2 |
과세형태
과세
영세
면세
|
|
writeDate | string | 8 |
작성일자
형식 : yyyyMMdd
|
|
regDT | string | 14 |
임시저장일시
형식 : yyyyMMddHHmmss
|
|
senderCorpName | string | 200 | 발신자 상호 | |
senderCorpNum | string | 10 | 발신자 사업자번호 | |
senderPrnumberYN | boolean | - |
발신자 인쇄여부
true인쇄
false미인쇄
|
|
receiverCorpName | string | 200 | 수신자 상호 | |
receiverCorpNum | string | 10 | 수신자 사업자번호 | |
receiverPrnumberYN | boolean | - |
수신자 인쇄여부
true인쇄
false미인쇄
|
|
supplyCostTotal | string | 18 |
공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
taxTotal | string | 18 |
세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
purposeType | string | 2 |
결제대금 수취여부
영수
청구
없음
|
|
issueDT | string | 14 |
발행일시
형식 : yyyyMMddHHmmss
|
|
stateCode | number | 3 | 상태코드 | |
stateDT | string | 14 |
상태 변경일시
형식 : yyyyMMddHHmmss
|
|
stateMemo | string | 200 | 상태메모 | |
openYN | boolean | - |
개봉여부
true개봉
false미개봉
|
|
openDT | string | 14 |
개봉 일시
형식 : yyyyMMddHHmmss
|
StatementLog
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
docLogType | number | 3 | 로그타입 | |
log | string | 2000 | 이력정보 | |
procType | string | 3 |
처리형태
연동API를 통해 처리함
일반팝빌 사이트를 통해 처리함
시스템팝빌이 처리함
|
|
procMemo | string | 200 | 처리메모 | |
regDT | string | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
ip | string | 39 | 아이피 |
AttachedFile
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
serialNum | number | 1 | 첨부파일 일련번호 | |
attachedFile | string | 255 | 첨부파일 삭제시 사용 | |
displayName | string | 255 | 첨부파일명 | |
regDT | string | 14 |
첨부일시
형식 : yyyyMMddHHmmss
|
EmailSendConfig
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
emailType | string | 9 |
전송 메일 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일 |
|
sendYN | boolean | - |
메일 전송 여부
true전송
false미전송
|
UseHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
total | number | - | 총 검색결과 건수 | |
perPage | number | - | 페이지당 목록 건수 | |
pageNum | number | - | 페이지 번호 | |
pageCount | number | - | 페이지 개수 | |
list | UseHistory[] | 사용내역 |
UseHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
itemCode | string | 3 |
서비스 코드
|
|
txType | string | 2 |
포인트 증감 유형
포인트 증가
포인트 감소
|
|
txPonumber | string | 18 | 증감 포인트 | |
balance | string | 18 | 잔여포인트 | |
txDT | string | 14 |
포인트 증감 일시
형식 : yyyyMMddHHmmss
|
|
userID | string | 50 | 담당자 아이디 | |
userName | string | 100 | 담당자명 |
PaymentHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
total | number | - | 총 검색결과 건수 | |
perPage | number | - | 페이지당 목록 건수 | |
pageNum | number | - | 페이지 번호 | |
pageCount | number | - | 페이지 개수 | |
list | PaymentHistory[] | 결제내역 |
PaymentHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
productType | string | 3 |
결제 내용
포인트
정액제
미수금
|
|
productName | string | 30 | 결제 상품명 | |
settleType | string | 7 |
결제유형
무통장
신용카드
실시간계좌이체
|
|
settlerName | string | 100 | 담당자명 | |
settlerEmail | string | 100 | 담당자메일 | |
settleCost | string | 18 | 결제금액 | |
settlePonumber | string | 18 | 충전포인트 | |
settleState | number | 1 |
결제상태
|
|
regDT | string | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
stateDT | string | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
RefundHistoryResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
total | number | - | 총 검색결과 건수 | |
perPage | number | - | 페이지당 목록 건수 | |
pageNum | number | - | 페이지 번호 | |
pageCount | number | - | 페이지 개수 | |
list | RefundHistory[] | 환불내역 |
RefundHistory
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
reqDT | string | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
requestPonumber | string | 18 | 환불 신청포인트 | |
accountBank | string | 10 | 환불계좌 은행명 | |
accountNum | string | 50 | 환불계좌번호 | |
accountName | string | 70 | 환불계좌 예금주명 | |
state | number | 1 |
상태
|
|
reason | string | 200 | 환불사유 |
RefundForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
ContactName | string | 100 | Y | 담당자명 | |
tel | string | 20 | Y | 담당자 연락처 | |
RequestPoint | string | 18 | Y | 환불 신청 포인트 | |
AccountBank | string | 10 | Y | 은행명 | |
AccountNum | string | 50 | Y | 계좌번호 | |
AccountName | string | 70 | Y | 예금주명 | |
Reason | string | 200 | N | 환불사유 |
PaymentForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
settlerName | string | 100 | N | 담당자명 | |
settlerEmail | string | 100 | N | 담당자 이메일 | |
notifyHP | string | 20 | N |
담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
|
|
paymentName | string | 70 | Y | 입금자명 | |
settleCost | string | 18 | Y | 결제금액 |
PaymentResponse
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - | 응답코드 | |
message | string | - | 응답메시지 | |
settleCode | string | 18 | 정산코드 |
ChargeInfo
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
unitCost | string | 12 | 발행단가 | |
chargeMethod | string | 3 |
과금유형
연동
파트너
|
|
rateSystem | string | 3 |
과금제도
종량제
|
JoinForm
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
ID | string | 50 | Y |
아이디
6자 이상 50자 이하
|
|
Password | string | 20 | Y |
비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함 |
|
LinkID | string | 20 | Y |
파트너 링크아이디
팝빌에서 발급한 링크아이디
|
|
CorpNum | string | 10 | Y | 사업자번호 ('-' 제외) | |
CEOName | string | 100 | Y | 대표자 성명 | |
CorpName | string | 200 | Y | 회사명 | |
Addr | string | 300 | Y | 사업장 주소 | |
BizType | string | 100 | Y | 업태 | |
BizClass | string | 100 | Y | 종목 | |
ContactName | string | 100 | Y | 담당자 성명 | |
ContactEmail | string | 100 | Y | 담당자 이메일 | |
ContactTEL | string | 20 | Y | 담당자 휴대폰 |
CorpInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
ceoname | string | 100 | Y | 대표자 성명 | |
corpName | string | 200 | Y | 회사명 | |
addr | string | 300 | Y | 주소 | |
bizType | string | 100 | Y | 업태 | |
bizClass | string | 100 | Y | 종목 |
ContactInfo - 입력부
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
id | string | 50 | Y |
아이디
6자 이상 50자 이하
|
|
password | string | 20 | 조건부 | 비밀번호 | |
personName | string | 100 | Y | 담당자 성명 | |
tel | string | 20 | Y | 담당자 휴대폰 | |
string | 100 | Y | 담당자 이메일 | ||
searchRole | number | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
id | string | 50 | 아이디 | |
personName | string | 100 | 담당자 성명 | |
tel | string | 20 | 담당자 휴대폰 | |
string | 100 | 담당자 이메일 | ||
regDT | string | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
searchRole | number | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
mgrYN | boolean | - |
관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
state | number | 1 |
계정상태
1사용중
|
RefundResponse
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 | |
refundCode | string | 18 | 환불코드 |