# 튜토리얼
Python 개발환경에서 팝빌 SDK를 추가하고, 전자세금계산서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
## 1. POPBiLL SDK 추가
팝빌 Python SDK를 추가하기 위해 pip install 명령어를 사용하여 패키지를 설치합니다.
```shell
$ pip install popbill
```
## 2. POPBiLL SDK 설정
Django 프로젝트의 settings.py 파일에 연동신청시 발급받은 API Key 와 연동환경 설정값을 선언합니다.
```python
# -*- coding: utf-8 -*-
import os
import sys
import imp
imp.reload(sys)
try:
sys.setdefaultencoding('UTF8')
except Exception as E:
pass
#생략
#...
#...
# API Key
# - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
# • LinkID: 파트너를 식별하기 위한 고유 식별자
# • SecretKey: API 인증토큰 발급에 사용되는 키
#
# TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
LinkID = "TESTER"
SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T="
# 연동환경(테스트/운영) 설정
# - 연동환경을 테스트 또는 운영으로 설정합니다.
# • True: 테스트 환경으로 설정
# • False(default) : 운영 환경으로 설정
#
# ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다.
IsTest = True
# 인증토큰 IP 일치 검증 사용 여부
# - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
# (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
# • True(사용, default) : 두 IP가 일치할 때만 API 호출 허용
# • False(미사용) : IP 일치 검사를 생략
#
# ※ False는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
# 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
IPRestrictOnOff = True
# 통신 IP 고정 여부
# - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
# • True(사용) : 고정(Static) IP 사용
# • False(미사용, default) : 가변(Elastic) IP 사용
#
# ※ True 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
# (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
UseStaticIP = False
# 로컬시스템 시간 사용 여부
# - 현재시각 기준을 설정합니다.
# • True(사용, default) : 로컬시스템 시간 사용
# • False(미사용) : 팝빌 서버의 시간을 사용
#
# ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
# ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
# ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 True를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
# 서버 시간을 신뢰하기 어려운 환경이면 False를 사용합니다.
UseLocalTimeYN = True
```
## 3. RegistIssue 기능 구현
Django App에 생성된 views.py 파일에 전자세금계산서 서비스 클래스 객체 생성과 전자세금계산서 즉시 발행 (RegistIssue) 함수 호출 코드를 추가합니다.
```python
# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import TaxinvoiceService, PopbillException, Taxinvoice, TaxinvoiceDetail, Contact, ContactInfo, JoinForm, CorpInfo
from config import settings
# settings.py 작성한 LinkID, SecretKey를 이용해 TaxinvoiceService 객체 생성
taxinvoiceService = TaxinvoiceService(settings.LinkID, settings.SecretKey)
# 연동환경 설정값, 개발용(True), 상업용(False)
taxinvoiceService.IsTest = settings.IsTest
# 인증토큰 IP제한기능 사용여부, 권장(True)
taxinvoiceService.IPRestrictOnOff = settings.IPRestrictOnOff
# 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
taxinvoiceService.UseStaticIP = settings.UseStaticIP
# 로컬시스템 시간 사용여부, 권장(True)
taxinvoiceService.UseLocalTimeYN = settings.UseLocalTimeYN
def registIssue(request):
try:
# 팝빌회원 사업자번호
CorpNum = "1234567890"
# 팝빌회원 아이디
UserID = "testkorea"
# [필수] 세금계산서 문서번호, 1~24자리, (영문, 숫자, '-', '_') 조합으로 사업자별로 중복되지 않도록 구성
MgtKey = "20250314-01"
# 지연발행 강제여부
# 발행마감일이 지난 세금계산서를 발행하는 경우, 가산세가 부과될 수 있습니다.
# 가산세가 부과되더라도 발행을 해야하는 경우에는 forceIssue의 값을 True로 선언
forceIssue = False
# 거래명세서 동시작성여부
writeSpecification = False
# 거래명세서 동시작성시, 명세서 문서번호, 1~24자리, (영문, 숫자, '-', '_') 조합으로 사업자별로 중복되지 않도록 구성
dealInvoiceMgtKey = ""
# 메모
memo = "즉시 발행 메모"
# 발행안내 메일 제목, 미기재시 기본양식으로 전송
emailSubject = ""
# 세금계산서 정보
taxinvoice = Taxinvoice(
# [필수] 작성일자, 날짜형식(yyyyMMdd)
writeDate="20250314",
# [필수] 과금방향, [정과금(공급자), 역과금(공급받는자)]중 기재
# 역과금의 경우 역발행세금계산서 발행시에만 사용가능
chargeDirection="정과금",
# [필수] 발행형태, [정발행, 역발행, 위수탁] 중 기재
issueType="정발행",
# [필수] [영수, 청구, 없음] 중 기재
purposeType="영수",
# [필수] 과세형태, [과세, 영세, 면세] 중 기재
taxType="과세",
######################################################################
# 공급자 정보
######################################################################
# [필수] 공급자 사업자번호 , '-' 없이 10자리 기재.
invoicerCorpNum=CorpNum,
# 공급자 종사업장 식별번호, 필요시 숫자 4자리 기재
invoicerTaxRegID=None,
# [필수] 공급자 상호
invoicerCorpName="공급자 상호",
# [필수] 공급자 문서번호, 1~24자리, (영문, 숫자, '-', '_') 조합으로
# 사업자별로 중복되지 않도록 구성
invoicerMgtKey=MgtKey,
# [필수] 공급자 대표자 성명
invoicerCEOName="공급자 대표자 성명",
# 공급자 주소
invoicerAddr="공급자 주소",
# 공급자 종목
invoicerBizClass="공급자 종목",
# 공급자 업태
invoicerBizType="공급자 업태",
# 공급자 담당자 성명
invoicerContactName="공급자 담당자명",
# 공급자 담당자 메일주소
invoicerEmail="test@test.com",
# 공급자 담당자 연락처
invoicerTEL="070-111-222",
# 공급자 담당자 휴대폰 번호
invoicerHP='010-111-222',
# 발행시 알림문자 전송여부 (정발행에서만 사용가능)
# - 공급받는자 주)담당자 휴대폰번호(invoiceeHP1)로 전송
# - 전송시 포인트가 차감되며 전송실패하는 경우 포인트 환불처리
invoicerSMSSendYN=False,
######################################################################
# 공급받는자 정보
######################################################################
# [필수] 공급받는자 유형, [사업자, 개인, 외국인] 중 기재
invoiceeType="사업자",
# [필수] 공급받는자 사업자번호, '-' 제외 10자리
invoiceeCorpNum="8888888888",
# 공급자 종사업장 식별번호, 필요시 숫자 4자리 기재
invoiceeTaxRegID=None,
# [필수] 공급받는자 상호
invoiceeCorpName="공급받는자 상호",
# [역발행시 필수] 공급받는자 문서번호, 1~24자리 (숫자, 영문, '-', '_') 조합으로 사업자별로 중복되지 않도록 구성
invoiceeMgtKey=None,
# [필수] 공급받는자 대표자 성명
invoiceeCEOName="공급받는자 대표자 성명",
# 공급받는자 주소
invoiceeAddr="공급받는자 주소",
# 공급받는자 종목
invoiceeBizClass="공급받는자 종목",
# 공급받는자 업태
invoiceeBizType="공급받는자 업태",
# 공급받는자 담당자 성명
invoiceeContactName1="공급받는자 담당자",
# 공급받는자 담당자 메일주소
# 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
# 실제 거래처의 메일주소가 기재되지 않도록 주의
invoiceeEmail1="test@test.com",
# 공급받는자 연락처
invoiceeTEL1="070-111-222",
# 공급받는자 담당자 휴대폰번호
invoiceeHP1="010-111-222",
# 공급받는자 담당자 팩스번호
invoiceeFAX1="070-111-222",
######################################################################
# 세금계산서 기재정보
######################################################################
# [필수] 공급가액 합계
supplyCostTotal="100000",
# [필수] 세액 합계
taxTotal="10000",
# [필수] 합계금액, 공급가액 합계 + 세액 합계
totalAmount="110000",
# 기재상 '일련번호' 항목
serialNum="123",
# 기재상 '현금' 항목
cash=None,
# 기재상 '수표' 항목
chkBill=None,
# 기재상 '어음' 항목
note=None,
# 기재상 '외상미수금' 항목
credit="",
# 기재 상 '비고' 항목
remark1="비고1",
remark2="비고2",
remark3="비고3",
# 기재상 '권' 항목, 최대값 32767
# 미기재시 kwon=None,
kwon=1,
# 기재상 '호' 항목, 최대값 32767
# 미기재시 ho=None,
ho=2,
# 사업자등록증 이미지 첨부여부
businessLicenseYN=False,
# 통장사본 이미지 첨부여부
bankBookYN=False,
######################################################################
# 수정세금계산서 정보 (수정세금계산서 발행시에만 기재)
# - 수정세금계산서 관련 정보는 연동매뉴얼 또는 개발가이드 링크 참조
# - [참고] 수정세금계산서 작성방법 안내 - http://blog.linkhub.com/650
######################################################################
# [수정세금계산서 작성시 필수] 수정세금계산서 정보 수정사유별로 1~6중 선택기재
# 수정사유코드
modifyCode=None,
# [수정세금계산서 작성시 필수] 당초 국세청승인번호 기재
orgNTSConfirmNum=None
)
######################################################################
# 상세항목(품목) 정보
######################################################################
# 상세항목 0~99개 까지 작성가능.
# 일련번호 (serialNum) 는 1부터 99까지 순차기재.
taxinvoice.detailList = []
taxinvoice.detailList.append(
TaxinvoiceDetail(
serialNum=1, # 일련번호, 1부터 순차기재
purchaseDT="20250314", # 거래일자, yyyyMMdd
itemName="품목1", # 품목
spec="규격", # 규격
qty=1, # 수량
unitCost="50000", # 단가
supplyCost="50000", # 공급가액
tax="5000", # 세액
remark="품목비고" # 비고
)
)
taxinvoice.detailList.append(
TaxinvoiceDetail(
serialNum=2, # 일련번호, 1부터 순차기재
purchaseDT="20250314", # 거래일자, yyyyMMdd
itemName="품목2", # 품목
spec="규격", # 규격
qty=1, # 수량
unitCost="50000", # 단가
supplyCost="50000", # 공급가액
tax="5000", # 세액
remark="품목비고" # 비고
)
)
######################################################################
# 추가담당자 정보
# - 세금계산서 발행안내 메일을 수신받을 공급받는자 담당자가 다수인 경우
# 담당자 정보를 추가하여 발행안내메일을 다수에게 전송할 수 있습니다.
######################################################################
# 최대 5개까지 기재 가능
taxinvoice.addContactList = []
taxinvoice.addContactList.append(
Contact(
serialNum=1, # 일련번호, 1부터 순차기재
contactName="추가담당자 성명", # 담당자명
email="test1@test.com" # 메일주소
)
)
taxinvoice.addContactList.append(
Contact(
serialNum=2, # 일련번호, 1부터 순차기재
contactName="추가담당자 성명", # 담당자명
email="test1@test.com" # 메일주소
)
)
response = taxinvoiceService.registIssue(CorpNum, taxinvoice, writeSpecification,
forceIssue, dealInvoiceMgtKey, memo, emailSubject, UserID)
return render(request, 'response.html', {'code': response.code, 'message': response.message, 'ntsConfirmNum': response.ntsConfirmNum})
except PopbillException as PE:
return render(request, 'exception.html', {'code': PE.code, 'message': PE.message})
```
함수 호출결과 코드와 메시지를 출력하는 “/response.html” 파일을 추가합니다.
```python
Popbill API Test.
Response
```
## 4. API 응답결과 확인
API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
| -- | --------------------------------------------------------------------------------------------- |
| 성공 | code : 1 |
| 실패 | code : 오류코드 (8자리 음의 정수) [\[오류코드\]](https://developers.popbill.com/error-code) message : 오류메시지 |