POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

KeyType

순번변수명타입길이설명
SELL enum - 매출
BUY enum - 매입

HTCashbillJobState

순번변수명타입길이설명
jobID string 18 작업아이디
jobState int? N 수집상태
1대기
2진행
3완료
queryType string - 수집유형
매출
매입
queryDateType string 9 수집 일자 유형
TradeDate거래일자
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

HTCashbill

순번변수명타입길이설명
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 가맹점(발행자) 사업자유형
  • 1일반과세자
  • 2간이과세자
  • 3과세특례자
  • 4면세사업자
  • 5법인사업자
{invoiceType}="매입" 경우 반환
identityNum string 4 식별번호
반환되는 식별번호의 값은 마지막 4자리 숫자값 반환
identityNumType string 1 식별번호 유형
  • 1주민등록번호
  • 2사업자번호
  • 3휴대전화번호
  • 4카드번호
customerName string 70 구매자(고객) 성명
cardOwnerName string 70 카드소유자명
deductionType string 1 공제유형
12 공제
34 불공제

HTCashbillSearch

순번변수명타입길이설명
code int? N API 처리에 대한 응답코드
1성공
message string - API 처리에 대한 응답메시지
total int? N 총 검색결과 건수
perPage int? N 페이지당 목록 건수
pageNum int? N 페이지 번호
pageCount int - 페이지 개수
list List<HTCashbill> 현금영수증 정보
최대 : 1,000건

HTCashbillSummary

순번변수명타입길이설명
count long? N 수집 건수
supplyCostTotal long? N 공급가액 합계
taxTotal long? N 세액 합계
serviceFeeTotal long? 18 봉사료 합계
amountTotal long? N 총계 (공급가액 합계+세액 합계)