A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| message | String | - | API 처리 실패에 대한 오류메시지 |
HTTIKeyType
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| SELL | String | - | 매출 | |
| BUY | String | - | 매입 | |
| TRUSTEE | String | - | 수탁 |
HTTIJobState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| jobID | String | 18 | 작업아이디 | |
| jobState | String | 1 |
수집상태
1대기
2진행
3완료
|
|
| queryType | String | 2 |
수집유형
매출
매입
수탁
|
|
| queryDateType | String | 9 |
일자유형
WriteDate작성일자
IssueDate발행일자
SendDate전송일자
|
|
| queryStDate | String | 8 |
시작일자
형식 : yyyyMMdd
|
|
| queryEnDate | String | 8 |
종료일자
형식 : yyyyMMdd
|
|
| errorCode | Integer | - |
수집 결과 코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
| errorReason | String | - |
오류메시지
수집실패시 반환되는 사유
|
|
| jobStartDT | String | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
| jobEndDT | String | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
| collectCount | Integer | - | 수집개수 | |
| regDT | String | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
HTTaxinvoice
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| writeDate | String | 8 |
작성일자
형식 : yyyyMMdd
|
|
| issueDT | String | 14 |
발행일시
형식 : yyyyMMddHHmmss
|
|
| invoiceType | Integer | 3 |
전자세금계산서 종류
|
|
| taxType | String | 2 |
과세형태
과세
영세
면세
|
|
| taxTotal | String | 18 | 세액 합계 | |
| supplyCostTotal | String | 18 | 공급가액 합계 | |
| totalAmount | String | 18 | 합계금액 | |
| purposeType | String | 2 |
영수/청구
영수
청구
없음
|
|
| serialNum | String | 30 | 일련번호 | |
| cash | String | 18 | 현금 | |
| chkBill | String | 18 | 수표 | |
| credit | String | 18 | 외상 | |
| note | String | 18 | 어음 | |
| remark1 | String | 150 | 비고1 | |
| remark2 | String | 150 | 비고2 | |
| remark3 | String | 150 | 비고3 | |
| ntsconfirmNum | String | 24 | 국세청승인번호 | |
| invoicerCorpNum | String | 10 | 공급자 사업자번호 | |
| invoicerMgtKey | String | 24 | 공급자 문서번호 | |
| invoicerTaxRegID | String | 4 |
공급자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| invoicerCorpName | String | 200 | 공급자 상호 | |
| invoicerCEOName | String | 100 | 공급자 대표자 성명 | |
| invoicerAddr | String | 300 | 공급자 주소 | |
| invoicerBizType | String | 100 | 공급자 업태 | |
| invoicerBizClass | String | 100 | 공급자 종목 | |
| invoicerContactName | String | 100 | 공급자 담당자 성명 | |
| invoicerDeptName | String | 100 | 공급자 담당자 부서명 | |
| invoicerTEL | String | 20 | 공급자 담당자 연락처 | |
| invoicerEmail | String | 100 | 공급자 담당자 이메일 | |
| invoiceeCorpNum | String | 13 |
공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우 사업자번호 - {invoiceeType}="개인" 경우 주민등록번호 - {invoiceeType}="외국인" 경우 "9999999999999" |
|
| invoiceeType | String | 3 |
공급받는자 구분
사업자
개인
외국인
|
|
| invoiceeMgtKey | String | 24 | 공급자 문서번호 | |
| invoiceeTaxRegID | String | 4 |
공급받는자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| invoiceeCorpName | String | 200 | 공급받는자 상호 | |
| invoicerCEOName | String | 100 | 공급받는자 대표자 성명 | |
| invoiceeAddr | String | 300 | 공급받는자 주소 | |
| invoiceeBizType | String | 100 | 공급받는자 업태 | |
| invoiceeBizClass | String | 100 | 공급받는자 종목 | |
| invoiceeContactName1 | String | 100 | 공급받는자 주) 담당자 성명 | |
| invoiceeDeptName1 | String | 100 | 공급받는자 주) 담당자 부서명 | |
| invoiceeTEL1 | String | 20 | 공급받는자 주) 담당자 연락처 | |
| invoiceeEmail1 | String | 100 | 공급받는자 주) 담당자 이메일 | |
| invoiceeContactName2 | String | 100 | 공급받는자 부) 담당자 성명 | |
| invoiceeDeptName2 | String | 100 | 공급받는자 부) 담당자 부서명 | |
| invoiceeTEL2 | String | 20 | 공급받는자 부) 담당자 연락처 | |
| invoiceeEmail2 | String | 100 | 공급받는자 부) 담당자 이메일 | |
| trusteeCorpNum | String | 10 | 수탁자 사업자번호 | |
| trusteeMgtKey | String | 24 | 수탁자 문서번호 | |
| trusteeTaxRegID | String | 4 |
수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| trusteeCorpName | String | 200 | 수탁자 상호 | |
| trusteeCEOName | String | 100 | 수탁자 대표자 성명 | |
| trusteeAddr | String | 300 | 수탁자 주소 | |
| trusteeBizType | String | 100 | 수탁자 업태 | |
| trusteeBizClass | String | 100 | 수탁자 종목 | |
| trusteeContactName | String | 100 | 수탁자 담당자 성명 | |
| trusteeDeptName | String | 100 | 수탁자 담당자 부서명 | |
| trusteeTEL | String | 20 | 수탁자 담당자 연락처 | |
| trusteeEmail | String | 100 | 수탁자 담당자 이메일 | |
| modifyCode | Integer | 1 |
수정 사유코드
|
|
| orgNTSConfirmNum | String | 24 | 당초승인번호 | |
| detailList | HTTaxinvoiceDetail[ ] |
품목 상세정보
최대 : 99건
|
||
HTTaxinvoiceDetail
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| serialNum | Integer | 2 | 일련번호 | |
| purchaseDT | String | 8 |
거래일자
형식 : yyyyMMdd
|
|
| itemName | String | 100 | 품명 | |
| spec | String | 60 | 규격 | |
| qty | String | 12 |
수량
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| unitCost | String | 18 |
단가
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| supplyCost | String | 18 |
공급가액
마이너스 금액 반환 가능
|
|
| tax | String | 18 |
세액
마이너스 금액 반환 가능
|
|
| remark | String | 100 | 비고 |
HTTaxinvoiceSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | 10 | API 처리에 대한 응답코드 | |
| message | String | - | API 처리에 대한 응답메시지 | |
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | HTTaxinvoiceAbbr[ ] |
세금계산서 요약정보
최대 : 1,000건
|
||
HTTaxinvoiceAbbr
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| ntsconfirmNum | String | 24 | 전자세금계산서 국세청승인번호 | |
| writeDate | String | 8 |
작성일자
형식 : yyyyMMdd
|
|
| issueDate | String | 8 |
발행일자
형식 : yyyyMMdd
|
|
| sendDate | String | 8 |
전송일자
형식 : yyyyMMdd
|
|
| taxType | String | 2 |
과세형태
과세
영세
면세
|
|
| purposeType | String | 2 |
영수/청구
영수
청구
없음
|
|
| supplyCostTotal | String | 18 |
공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|
| taxTotal | String | 18 | 세액 합계 | |
| totalAmount | String | 18 | 합계금액 | |
| remark1 | String | 450 |
비고
전자세금계산서 비고1/2/3 값의 합
|
|
| invoiceType | String | 2 |
세금계산서 유형
매입
매출
|
|
| modifyYN | Boolean | - |
수정 전자세금계산서 여부
true수정세금계산서
false일반세금계산서
|
|
| orgNTSConfirmNum | String | 24 | 당초승인번호 | |
| purchaseDate | String | 8 |
거래일자
형식 : yyyyMMdd
|
|
| itemName | String | 100 | 품명 | |
| spec | String | 60 | 규격 | |
| qty | String | 12 |
수량
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| unitCost | String | 18 |
단가
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| supplyCost | String | 18 |
공급가액
마이너스 금액 반환 가능
|
|
| tax | String | 18 |
세액
마이너스 금액 반환 가능
|
|
| remark | String | 100 | 비고 | |
| invoicerCorpNum | String | 10 | 공급자 사업자번호 | |
| invoicerTaxRegID | String | 4 |
공급자 종사업장번호 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| invoicerCorpName | String | 200 | 공급자 상호 | |
| invoicerCEOName | String | 100 | 공급자 대표자 성명 | |
| invoicerEmail | String | 100 | 공급자 담당자 이메일 | |
| invoiceeCorpNum | String | 13 |
공급받는자 등록번호 ('-' 제외)
- {invoiceeType}="사업자" 경우 사업자번호 - {invoiceeType}="개인" 경우 주민등록번호 - {invoiceeType}="외국인" 경우 "9999999999999" |
|
| invoiceeType | String | 3 |
공급받는자 구분
사업자
개인
외국인
|
|
| invoiceeTaxRegID | String | 4 |
공급받는자 종사업장번호 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| invoiceeCorpName | String | 200 | 공급받는자 상호 | |
| invoiceeCEOName | String | 100 | 공급받는자 대표자 성명 | |
| invoiceeEmail1 | String | 100 | 공급받는자 담당자 이메일 | |
| invoiceeEmail2 | String | 70 | 공급받는자 ASP 연계사업자 메일 | |
| trusteeCorpNum | String | 10 | 수탁자 사업자번호 | |
| trusteeTaxRegID | String | 4 |
수탁자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| trusteeCorpName | String | 200 | 수탁자 상호 | |
| trusteeCEOName | String | 100 | 수탁자 대표자 성명 | |
| trusteeEmail | String | 100 | 수탁자 담당자 이메일 |
HTTaxinvoiceSummary
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| count | Integer | - | 수집 결과 건수 | |
| supplyCostTotal | Integer | 18 | 공급가액 합계 | |
| taxTotal | Integer | 18 | 세액 합계 | |
| amountTotal | Integer | 18 | 합계 금액 |
HTTaxinvoiceXMLResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| ResultCode | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| Message | String | 24 | API 처리에 대한 응답메시지 | |
| retObject | String | - | 전자세금계산서 XML 문서 |
HTTIFlatRate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| referenceID | Integer | 10 | 사업자번호 ('-' 제외) | |
| contractDT | String | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
| useEndDate | String | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
| baseDate | Integer | 2 |
자동연장 결제일
5
15
25
|
|
| state | String | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
| closeRequestYN | Boolean | - |
정액제 서비스 해지신청 여부
true신청
false미신청
|
|
| useRestrictYN | Boolean | - |
정액제 서비스 해지 여부
true사용제한
false사용
|
|
| closeOnExpired | Boolean | - |
정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
|
|
| unPaidYN | Boolean | - |
미수금 보유 여부
true보유
false미보유
|
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | UseHistory[ ] | 사용내역 | ||
UseHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| itemCode | String | 3 |
서비스 코드
|
|
| txType | String | 2 |
포인트 증감 유형
포인트 증가
포인트 감소
|
|
| txPoint | String | 18 | 증감 포인트 | |
| balance | String | 18 | 잔여포인트 | |
| txDT | String | 14 |
포인트 증감 일시
형식 : yyyyMMddHHmmss
|
|
| userID | String | 50 | 담당자 아이디 | |
| userName | String | 100 | 담당자명 |
PaymentHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | PaymentHistory[ ] | 사용내역 | ||
PaymentHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| productType | String | 3 |
결제 내용
포인트
정액제
미수금
|
|
| productName | String | 30 | 결제 상품명 | |
| settleType | String | 7 |
결제유형
무통장
신용카드
실시간계좌이체
|
|
| settlerName | String | 100 | 담당자명 | |
| settlerEmail | String | 100 | 담당자메일 | |
| settleCost | String | 18 | 결제금액 | |
| settlePoint | String | 18 | 충전포인트 | |
| settleState | Integer | 1 |
결제상태
|
|
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| stateDT | String | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | RefundHistory[ ] | 환불신청 내역 | ||
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| reqDT | String | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
| requestPoint | String | 18 | 환불 신청포인트 | |
| accountBank | String | 10 | 환불계좌 은행명 | |
| accountNum | String | 50 | 환불계좌번호 | |
| accountName | String | 70 | 환불계좌 예금주명 | |
| state | Integer | 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 | Integer | - | 응답코드 | |
| 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 | Integer | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 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사용중
|
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| refundCode | String | 18 | 환불코드 |