A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
message | string | - | API 처리 실패에 대한 오류메시지 |
QueryType
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
SELL | enum | - | 매출 | |
BUY | enum | - | 매입 |
HTCashbillJobState
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
jobID | string | 18 | 작업아이디 | |
jobState | string | 1 |
수집상태
1대기
2진행
3완료
|
|
queryType | string | 2 |
수집유형
매출
매입
|
|
queryDateType | string | 9 |
수집 일자 유형
TradeDate거래일자
|
|
queryStDate | string | 8 |
시작일자
형식 : yyyyMMdd
|
|
queryEnDate | string | 8 |
종료일자
형식 : yyyyMMdd
|
|
errorCode | number | - |
수집 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
errorReason | string | - |
오류메시지
수집실패시 반환되는 사유
|
|
jobStartDT | string | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
jobEndDT | string | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
collectCount | number | - | 수집개수 | |
regDT | string | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
HTCashbill
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
ntsconfirmNum | string | 24 | 국세청승인번호 | |
tradeDate | string | 8 |
거래일자
형식 : yyyyMMdd
|
|
tradeDT | string | 14 |
거래일시
형식 : yyyyMMddHHmmss
|
|
tradeType | string | 4 |
문서형태
승인거래
취소거래
|
|
tradeUsage | string | 5 |
거래구분
소득공제용
지출증빙용
|
|
totalAmount | string | 9 | 거래금액 | |
supplyCost | string | 9 | 공급가액 | |
tax | string | 9 | 부가세 | |
serviceFee | string | 9 | 봉사료 | |
invoiceType | string | 2 |
현금영수증 유형
매입
매출
|
|
franchiseCorpNum | string | 10 |
가맹점(발행자) 사업자번호
{invoiceType}="매입" 경우 반환
|
|
franchiseCorpName | string | 200 |
가맹점(발행자) 상호
{invoiceType}="매입" 경우 반환
|
|
franchiseCorpType | string | 1 |
가맹점(발행자) 사업자유형
1일반과세자
2간이과세자
3법인과세자
{invoiceType}="매입" 경우 반환
|
|
identityNum | string | 4 |
식별번호
반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
|
|
identityNumType | string | 1 |
식별번호 유형
|
|
customerName | string | 70 | 구매자(고객) 성명 | |
cardOwnerName | string | 70 | 카드소유자명 | |
deductionType | string | 1 |
공제유형
12 공제
34 불공제
|
HTCashbillSearchResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | number | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 | |
total | number | - | 총 검색결과 건수 | |
perPage | number | - | 페이지당 목록 건수 | |
pageNum | number | - | 페이지 번호 | |
pageCount | number | - | 페이지 개수 | |
list | HTCashbill[] |
현금영수증 정보
최대 : 1,000건
|
HTCashbillSummary
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
count | number | - | 수집 결과 건수 | |
supplyCostTotal | number | 18 | 공급가액 합계 | |
taxTotal | number | 18 | 세액 합계 | |
serviceFeeTotal | number | 18 | 봉사료 합계 | |
amountTotal | number | 18 | 합계 금액 |
FlatRateState
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
referenceID | string | 10 | 사업자번호 ('-' 제외) | |
contractDT | string | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
useEndDate | string | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
baseDate | number | 2 |
자동연장 결제일
5
15
25
|
|
state | number | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
closeRequestYN | boolean | - |
정액제 서비스 해지신청 여부
true신청
false미신청
|
|
useRestrictYN | boolean | - |
정액제 서비스 사용제한 여부
true사용제한
false사용
|
|
closeOnExpired | boolean | - |
정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
|
|
unPaidYN | 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 | - | 요금 | |
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 | 환불코드 |