A. 객체정보
PBResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 |
Err (Property)
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| LastErrCode | Long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |
KeyType (Enum)
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| SELL | Enum | - | 매출 | |
| BUY | Enum | - | 매입 |
PBHTCashbillJobState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| jobID | String | 18 | 작업아이디 | |
| jobState | Integer | - |
수집상태
1대기
2진행
3완료
|
|
| queryType | String | - |
수집유형
매출
매입
|
|
| queryDateType | String | 9 |
수집 일자 유형
TradeDate거래일자
|
|
| queryStDate | String | 8 |
시작일자
형식 : yyyyMMdd
|
|
| queryEnDate | String | 8 |
종료일자
형식 : yyyyMMdd
|
|
| errorCode | long | - |
수집 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
| errorReason | String | - |
오류메시지
수집실패시 반환되는 사유
|
|
| jobStartDT | String | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
| jobEndDT | String | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
| collectCount | Integer | - | 수집개수 | |
| regDT | String | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
PBHTCashbill
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 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 |
가맹점(발행자) 사업자유형
{invoiceType}="매입" 경우 반환
|
|
| identityNum | String | 4 |
식별번호
반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
|
|
| identityNumType | String | 1 |
식별번호 유형
|
|
| customerName | String | 70 | 구매자(고객) 성명 | |
| cardOwnerName | String | 70 | 카드소유자명 | |
| deductionType | String | 1 |
공제유형
12 공제
34 불공제
|
PBHTCashbillSearch
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | PBHTCashbill[ ] |
현금영수증 정보
최대 : 1,000건
|
||
PBHTCashbillSummary
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| count | Long | - | 수집 결과 건수 | |
| supplyCostTotal | Long | 18 | 공급가액 합계 | |
| taxTotal | Long | 18 | 세액 합계 | |
| serviceFeeTotal | Long | 18 | 봉사료 합계 | |
| amountTotal | Long | 18 | 합계 금액 |
PBHTCashbillFlatRate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| referenceID | String | 10 | 사업자번호 ('-' 제외) | |
| contractDT | String | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
| useEndDate | String | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
| baseDate | Integer | 2 |
자동연장 결제일
5
15
25
|
|
| state | Integer | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
| closeRequestYN | Boolean | - |
정액제 서비스 해지신청 여부
True신청
False미신청
|
|
| useRestrictYN | Boolean | - |
정액제 서비스 사용제한 여부
True사용제한
False사용
|
|
| closeOnExpired | Boolean | - |
정액제 서비스 해지 구분
True일반해지 (정액제 서비스 만료일 해지)
False중도해지 (요청 즉시 해지)
|
|
| unPaidYN | Boolean | - |
미수금 보유 여부
True보유
False미보유
|
PBChargeInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| unitCost | String | 12 | 요금 | |
| chargeMethod | String | 3 |
과금유형
연동
파트너
|
|
| rateSystem | String | 3 |
요금제도
정액제
종량제
|
PBJoinForm
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 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 | 담당자 휴대폰 |
PBCorpInfo
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ceoname | String | 100 | Y | 대표자 성명 | |
| corpName | String | 200 | Y | 회사명 | |
| addr | String | 300 | Y | 주소 | |
| bizType | String | 100 | Y | 업태 | |
| bizClass | String | 100 | Y | 종목 |
PBContactInfo - 입력부
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| id | String | 50 | Y |
아이디
6자 이상 50자 이하
|
|
| password | String | 20 | 조건부 | 비밀번호 | |
| personName | String | 100 | Y | 담당자 성명 | |
| tel | String | 20 | Y | 담당자 휴대폰 | |
| String | 100 | Y | 담당자 이메일 | ||
| searchRole | Integer | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
PBContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | String | 50 | 아이디 | |
| personName | String | 100 | 담당자 성명 | |
| tel | String | 20 | 담당자 휴대폰 | |
| String | 100 | 담당자 이메일 | ||
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | Integer | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | Boolean | - |
관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | Integer | 1 |
계정상태
1사용중
|