POPBill Developers
API Reference

A. 객체정보

PBResponse

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지

Err (Property)

순번변수명타입길이설명
LastErrCode Long - API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
LastErrMessage String - API 처리 실패에 대한 오류메시지

KeyType (Enum)

순번변수명타입길이설명
SELL Enum - 매출
BUY Enum - 매입
TRUSTEE Enum - 수탁

PBHTTaxinvoiceJobState

순번변수명타입길이설명
jobID String 18 작업아이디
jobState Integer - 수집상태
1대기
2진행
3완료
queryType String 2 수집유형
매출
매입
수탁
queryDateType String 9 일자유형
WriteDate작성일자
IssueDate발행일자
SendDate전송일자
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

PBHTTaxinvoice

순번변수명타입길이설명
writeDate String 8 작성일자
형식 : yyyyMMdd
issueDT String 14 발행일시
형식 : yyyyMMddHHmmss
invoiceType String 3 전자세금계산서 종류
  • 101세금계산서
  • 102영세율 세금계산서
  • 103위수탁 세금계산서
  • 104수입 세금계산서
  • 105위수탁영세율 세금계산서
  • 201수정세금계산서
  • 202영세율 수정세금계산서
  • 203위수탁 수정세금계산서
  • 204수입 수정세금계산서
  • 205위수탁영세율 수정세금계산서
  • 301계산서
  • 303위수탁 계산서
  • 304수입 계산서
  • 401수정계산서
  • 403위수탁 수정계산서
  • 404수입 수정계산서
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 수정 사유코드
  • 1기재사항 착오정정
  • 2공급가액 변동
  • 3환입
  • 4계약의 해지
  • 5내국신용장 사후개설
  • 6착오에 의한 이중발행
orgNTSConfirmNum String 24 당초승인번호
detailList PBHTTaxinvoiceDetail 품목 상세정보
최대 : 99건

PBHTTaxinvoiceDetail

순번변수명타입길이설명
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 비고

PBHTTaxinvoiceSearch

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 목록 건수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
list PBHTTaxinvoiceAbbr[ ] 세금계산서 요약정보
최대 : 1,000건

PBHTTaxinvoiceAbbr

순번변수명타입길이설명
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 150 비고
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 수탁자 담당자 이메일

PBHTTaxinvoiceSummary

순번변수명타입길이설명
count long - 수집 결과 건수
supplyCostTotal long 18 공급가액 합계
taxTotal long 18 세액 합계
amountTotal long 18 합계 금액

PBHTTaxinvoiceXML

순번변수명타입길이설명
ResultCode Long - API 처리에 대한 응답코드
1성공
Message String 24 API 처리에 대한 응답메시지
retObject String - 전자세금계산서 XML 문서

PBHTTaxinvoiceFlatRate

순번변수명타입길이설명
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 조건부 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자 조합
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole Integer 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

PBContactInfo - 출력부

순번변수명타입길이설명
id String 50 아이디
personName String 100 담당자 성명
tel String 20 담당자 휴대폰
email String 100 담당자 이메일
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
searchRole Integer 1 담당자 권한
1개인권한
2읽기권한
3회사권한
mgrYN Boolean - 관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state Integer 1 계정상태
1사용중