A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| Message | string | - | API 처리 실패에 대한 오류메시지 |
KeyType
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| SELL | enum | - | 매출 | |
| BUY | enum | - | 매입 | |
| TRUSTEE | enum | - | 수탁 |
HTTaxinvoiceJobState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| jobID | string | 18 | 작업아이디 | |
| jobState | int? | N |
수집상태
1대기
2진행
3완료
|
|
| queryType | string | 2 |
수집유형
매출
매입
수탁
|
|
| queryDateType | string | 9 |
일자유형
WriteDate작성일자
IssueDate발행일자
SendDate전송일자
|
|
| queryStDate | string | 8 |
시작일자
형식 : yyyyMMdd
|
|
| queryEnDate | string | 8 |
종료일자
형식 : yyyyMMdd
|
|
| errorCode | long? | N |
수집 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
| errorReason | string | - |
오류메시지
수집실패시 반환되는 사유
|
|
| jobStartDT | string | 14 |
작업 시작일시
형식 : yyyyMMddHHmmss
|
|
| jobEndDT | string | 14 |
작업 종료일시
형식 : yyyyMMddHHmmss
|
|
| collectCount | long | - | 수집개수 | |
| regDT | string | 14 |
수집 요청일시
형식 : yyyyMMddHHmmss
|
HTTaxinvoice
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| writeDate | string | 8 |
작성일자
형식 : yyyyMMdd
|
|
| issueDT | string | 14 |
발행일시
형식 : yyyyMMddHHmmss
|
|
| invoiceType | int? | 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 | int? | 1 |
수정 사유코드
|
|
| orgNTSConfirmNum | string | 24 | 당초 국세청승인번호 | |
| detailList | List<HTTaxinvoiceDetail> |
품목 상세정보
최대 : 99건
|
||
HTTaxinvoiceDetail
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| serialNum | int? | 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 | 비고 |
HTTaxinvoiceSearch
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int? | N | API 처리에 대한 응답코드 | |
| message | string | - | API 처리에 대한 응답메시지 | |
| total | int? | N | 총 검색결과 건수 | |
| perPage | int? | N | 페이지당 목록 건수 | |
| pageNum | int? | N | 페이지 번호 | |
| pageCount | int? | N | 페이지 개수 | |
| list | 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 | bool? | N |
수정 전자세금계산서 여부
true수정세금계산서
false일반세금계산서
|
|
| orgNTSConfirmNum | string | 24 | 당초 국세청승인번호 | |
| purchaseDate | string | 8 |
품목1의 거래일자
형식 : yyyyMMdd
|
|
| itemName | string | 100 | 품목1의 품명 | |
| spec | string | 60 | 품목1의 규격 | |
| qty | string | 12 |
품목1의 수량
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| unitCost | string | 18 |
품목1의 단가
소수점 아래 2번째 자리까지 반환 가능
마이너스 금액 반환 가능 |
|
| supplyCost | string | 18 |
품목1의 공급가액
마이너스 금액 반환 가능
|
|
| tax | string | 18 |
품목1의 세액
마이너스 금액 반환 가능
|
|
| remark | string | 100 | 품목1의 비고 | |
| 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 | long | - | 수집 건수 | |
| supplyCostTotal | long | 18 | 공급가액 합계 | |
| taxTotal | long | 18 | 세액 합계 | |
| amountTotal | long | 18 | 총계 (공급가액 합계+세액 합계) |
HTTaxinvoiceXML
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| ResultCode | long? | N |
API 처리에 대한 응답코드
1성공
|
|
| Message | string | 24 | API 처리에 대한 응답메시지 | |
| retObject | string | - | 전자세금계산서 XML 문서 |
HTFlatRate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| referenceID | string | 10 | 사업자번호 ('-' 제외) | |
| contractDT | string | 14 |
정액제 서비스 시작일시
형식 : yyyyMMddHHmmss
|
|
| useEndDate | string | 8 |
정액제 서비스 만료일자
형식 : yyyyMMdd
|
|
| baseDate | int? | 2 | 자동연장 결제일 : 5 / 15 / 25 중 반환 | |
| state | int? | 1 |
정액제 서비스 상태
1사용 또는 사용제한
2해지
|
|
| closeRequestYN | bool? | N |
정액제 서비스 해지신청 여부
true신청
false미신청
|
|
| useRestrictYN | bool? | N |
정액제 서비스 해지 여부
true사용제한
false사용
|
|
| closeOnExpired | bool? | N |
정액제 서비스 해지 구분
true일반해지 (정액제 서비스 만료일 해지)
false중도해지 (요청 즉시 해지)
|
|
| unPaidYN | bool? | N |
미수금 보유 여부
true보유
false미보유
|
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | long | - | 총 검색결과 건수 | |
| perPage | long | - | 페이지당 목록 건수 | |
| pageNum | long | - | 페이지 번호 | |
| pageCount | long | - | 페이지 개수 | |
| list | List<UseHistory> | 사용내역 | ||
UseHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| itemCode | int | 3 | 서비스 코드
|
|
| txType | int | 2 | 포인트 증감 유형
포인트 증가
포인트 감소
|
|
| txPoint | string | 18 | 증감 포인트 | |
| balance | string | 18 | 잔여포인트 | |
| txDT | string | 14 | 포인트 증감 일시
형식 : yyyyMMddHHmmss
|
|
| userID | string | 50 | 담당자 아이디 | |
| userName | string | 100 | 담당자명 |
PaymentHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - | API 처리에 대한 응답코드
1성공
|
|
| total | long | - | 총 검색결과 건수 | |
| perPage | long | - | 페이지당 목록 건수 | |
| pageNum | long | - | 페이지 번호 | |
| pageCount | long | - | 페이지 개수 | |
| list | 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 | int | 1 | 결제상태
|
|
| regDT | string | 14 | 등록일시
형식 : yyyyMMddHHmmss
|
|
| stateDT | string | 14 | 상태일시
형식 : yyyyMMddHHmmss
|
PaymentForm
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| settlerName | string | 100 | N | 담당자명 | |
| settlerEmail | string | 100 | N | 담당자 이메일 | |
| notifyHP | string | 20 | N | 담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
|
|
| paymentName | string | 70 | Y | 입금자명 | |
| settleCost | string | 18 | Y | 결제금액 |
PaymentResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - | 응답코드 | |
| message | string | - | 응답메시지 | |
| settleCode | string | 18 | 정산코드 |
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - | API 처리에 대한 응답코드
1성공
|
|
| total | long | - | 총 검색결과 건수 | |
| perPage | long | - | 페이지당 목록 건수 | |
| pageNum | long | - | 페이지 번호 | |
| pageCount | long | - | 페이지 개수 | |
| list | List<RefundHistory> | 환불내역 | ||
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| reqDT | string | 14 | 신청일시
형식 : yyyyMMddHHmmss
|
|
| requestPoint | string | 18 | 환불 신청포인트 | |
| accountBank | string | 10 | 환불계좌 은행명 | |
| accountNum | string | 50 | 환불계좌번호 | |
| accountName | string | 70 | 환불계좌 예금주명 | |
| state | int | 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 | 환불사유 |
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - | API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 | |
| refundCode | 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 | 종목 |
Contact - 입력부
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| id | string | 50 | Y |
아이디
6자 이상 50자 이하
|
|
| password | string | 20 | 조건부 | 비밀번호 | |
| personName | string | 100 | Y | 담당자 성명 | |
| tel | string | 20 | Y | 담당자 휴대폰 | |
| string | 100 | Y | 담당자 이메일 | ||
| searchRole | int | 1 | N |
권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
Contact - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | string | 50 | 아이디 | |
| personName | string | 100 | 담당자 성명 | |
| tel | string | 20 | 담당자 휴대폰 | |
| string | 100 | 담당자 이메일 | ||
| regDT | string | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | int | 1 |
권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | bool? | - |
역할
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | int | 1 |
계정상태
1사용중
|