A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| message | str | - | API 처리 실패에 대한 오류메시지 |
HTCashbillJobState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| jobID | str | 18 | 작업아이디 | |
| jobState | str | 1 |
수집상태
1대기
2진행
3완료
|
|
| Type | str | - |
수집유형
매출
매입
|
|
| queryDateType | str | 9 |
수집 일자 유형
TradeDate거래일자
|
|
| queryStDate | str | 8 |
시작일자
형식 : yyyyMMdd
|
|
| queryEnDate | str | 8 |
종료일자
형식 : yyyyMMdd
|
|
| errorCode | int | - |
수집 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
| errorReason | str | - |
오류메시지
수집실패시 반환되는 사유
|
|
| jobStartDT | str | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
| jobEndDT | str | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
| collectCount | int | - | 수집개수 | |
| regDT | str | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
HTCashbill
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| ntsconfirmNum | str | 24 | 국세청승인번호 | |
| tradeDate | str | 8 |
거래일자
형식 : yyyyMMdd
|
|
| tradeDT | str | 14 |
거래일시
형식 : yyyyMMddHHmmss
|
|
| tradeType | str | 4 |
문서형태
승인거래
취소거래
|
|
| tradeUsage | str | 5 |
거래구분
소득공제용
지출증빙용
|
|
| totalAmount | str | 9 | 거래금액 | |
| supplyCost | str | 9 | 공급가액 | |
| tax | str | 9 | 부가세 | |
| serviceFee | str | 9 | 봉사료 | |
| invoiceType | str | 2 |
현금영수증 유형
매입
매출
|
|
| franchiseCorpNum | str | 10 |
가맹점(발행자) 사업자번호
{invoiceType}="매입" 경우 반환
|
|
| franchiseCorpName | str | 200 |
가맹점(발행자) 상호
{invoiceType}="매입" 경우 반환
|
|
| franchiseCorpType | str | 1 |
가맹점(발행자) 사업자유형
1일반과세자
2간이과세자
3법인과세자
{invoiceType}="매입" 경우 반환
|
|
| identityNum | str | 4 |
식별번호
반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
|
|
| identityNumType | str | 1 |
식별번호 유형
|
|
| customerName | str | 70 | 구매자(고객) 성명 | |
| cardOwnerName | str | 70 | 카드소유자명 | |
| deductionType | str | 1 |
공제유형
12 공제
34 불공제
|
HTCashbillSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| total | int | - | 총 검색결과 건수 | |
| perPage | int | - | 페이지당 목록 건수 | |
| pageNum | int | - | 페이지 번호 | |
| pageCount | int | - | 페이지 개수 | |
| list | HTCashbill[] |
현금영수증 정보
최대 : 1,000건
|
||
HTCashbillSummary
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| count | int | - | 수집 결과 건수 | |
| supplyCostTotal | int | 18 | 공급가액 합계 | |
| taxTotal | int | 18 | 세액 합계 | |
| serviceFeeTotal | int | 18 | 봉사료 합계 | |
| amountTotal | int | 18 | 합계 금액 |
FlatRateState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| referenceID | str | 10 | 사업자번호 ('-' 제외) | |
| contractDT | str | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
| useEndDate | str | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
| baseDate | int | 2 |
자동연장 결제일
5
15
25
|
|
| state | int | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
| closeRequestYN | bool | - |
정액제 서비스 해지신청 여부
True신청
False미신청
|
|
| useRestrictYN | bool | - |
정액제 서비스 사용제한 여부
True사용제한
False사용
|
|
| closeOnExpired | bool | - |
정액제 서비스 해지 구분
True일반해지 (정액제 서비스 만료일 해지)
False중도해지 (요청 즉시 해지)
|
|
| unPaidYN | bool | - |
미수금 보유 여부
True보유
False미보유
|
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| 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 | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| 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 |
결제상태
|
|
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| stateDT | str | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| list | RefundHistory[] | 환불내역 | ||
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| reqDT | str | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
| requestPoint | str | 18 | 환불 신청포인트 | |
| accountBank | str | 10 | 환불계좌 은행명 | |
| accountNum | str | 50 | 환불계좌번호 | |
| accountName | str | 70 | 환불계좌 예금주명 | |
| state | int | 1 |
상태
|
|
| 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 | str | - | 응답코드 | |
| message | str | - | 응답메시지 | |
| settleCode | str | 18 | 정산코드 |
ChargeInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| unitCost | str | - | 요금 | |
| 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 | 사업자번호 ('-' 제외) | |
| 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 | 조건부 | 비밀번호 | |
| personName | str | 100 | Y | 담당자 성명 | |
| tel | str | 20 | Y | 담당자 휴대폰 | |
| str | 100 | Y | 담당자 이메일 | ||
| searchRole | int | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | str | 50 | 아이디 | |
| personName | str | 100 | 담당자 성명 | |
| tel | str | 20 | 담당자 휴대폰 | |
| str | 100 | 담당자 이메일 | ||
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | int | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | bool | - |
관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | int | 1 |
계정상태
1사용중
|
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| refundCode | str | 18 | 환불코드 |