튜토리얼
Python 개발환경에서 팝빌 SDK를 추가하여 전자명세서 즉시 발행 (RegistIssue) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가
팝빌 Python SDK를 추가하기 위해 pip install 명령어를 사용하여 패키지를 설치합니다.
$ pip install popbill2. POPBiLL SDK 설정
Django 프로젝트의 settings.py 파일에 연동신청시 발급받은 API Key 와 연동환경 설정값을 선언합니다.
# -*- coding: utf-8 -*-
import os
import sys
import imp
imp.reload(sys)
try:
sys.setdefaultencoding('UTF8')
except Exception as E:
pass
#생략
#...
#...
# 링크아이디
LinkID = "TESTER"
# 비밀키
SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T="
# 연동환경 설정, True-테스트, False-운영(Production), (기본값:False)
IsTest = True
# 인증토큰 IP 검증 설정, True-사용, False-미사용, (기본값:True)
IPRestrictOnOff = True
# 통신 IP 고정, True-사용, False-미사용, (기본값:False)
UseStaticIP = False
# 로컬시스템 시간 사용여부, True-사용, False-미사용, (기본값:True)
UseLocalTimeYN = True3. RegistIssue 기능 구현
Django App에 생성된 views.py 파일에 전자명세서 서비스 클래스 객체 생성과 전자명세서 즉시 발행 (RegistIssue) 함수 호출 코드를 추가합니다.
# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import StatementService, PopbillException, Statement, StatementDetail, JoinForm, ContactInfo, CorpInfo
from config import settings
# settings.py 작성한 LinkID, SecretKey를 이용해 StatementService 객체 생성
statementService = StatementService(settings.LinkID, settings.SecretKey)
# 연동환경 설정값, 개발용(True), 상업용(False)
statementService.IsTest = settings.IsTest
# 인증토큰 IP제한기능 사용여부, 권장(True)
statementService.IPRestrictOnOff = settings.IPRestrictOnOff
# 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
statementService.UseStaticIP = settings.UseStaticIP
#로컬시스템 시간 사용여부, 권장(True)
statementService.UseLocalTimeYN = settings.UseLocalTimeYN
def registIssue(request):
try:
# 팝빌회원 사업자번호
CorpNum = "1234567890"
# 팝빌회원 아이디
UserID = "testkorea"
# 메모
Memo = "즉시 발행 메모"
# 전자명세서 정보
statement = Statement(
# [필수] 작성일자 yyyyMMdd
writeDate="20220101",
# [필수] [영수 / 청구 / 없음] 중 기재
purposeType="영수",
# [필수] 과세형태, [과세 / 영세 / 면세] 중 기재
taxType="과세",
# 맞춤양식코드, 미기재시 기본양식으로 처리
formCode="",
# [필수] 명세서 코드, [121-거래명세서], [122-청구서], [123-견적서], [124-발주서], [125-입금표], [126-영수증]
itemCode=121,
# [필수] 전자명세서 문서번호, 1~24자리, 영문,숫자,-,_ 조합으로 발신자별 고유번호 생성
mgtKey="20220101-001",
# [필수] 발신자 사업자번호, '-' 제외 10자리
senderCorpNum=CorpNum,
# 발신자 상호
senderCorpName="발신자 상호",
# 발신자 주소
senderAddr="발신자 주소",
# 발신자 대표자 성명
senderCEOName="발신자 대표자 성명",
# 발신자 종사업장 식별번호, 필요시 4자리 숫자값 기재
senderTaxRegID="",
# 발신자 종목
senderBizClass="종목",
# 발신자 업태
senderBizType="업태",
# 발신자 담당자 성명
senderContactName="발신자 담당자명",
# 발신자 메일주소
senderEmail="test@test.com",
# 발신자 연락처
senderTEL="070-1234-1234",
# 발신자 휴대폰번호
senderHP="010-000-222",
# [필수] 수신자 사업자번호, '-' 제외 10자리
receiverCorpNum="8888888888",
# 수신자 상호
receiverCorpName="수신자 상호",
# [필수] 수신자 대표자 성명
receiverCEOName="수신자 대표자 성명",
# 수신자 주소
receiverAddr="수신자 주소",
# 수신자 종사업장식별번호, 필요시 4자리 숫자값 기재
receiverTaxRegID="",
# 수신자 종목
receiverBizClass="수신자 종목",
# 수신자 업태
receiverBizType="수신자 업태",
# 수신자 담당자 성명
receiverContactName="수신자 담당자명",
# 수신자 메일주소
# 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
# 실제 거래처의 메일주소가 기재되지 않도록 주의
receiverEmail="test@test.com",
# 수신자 연락처
receiverTEL="070111222",
# 수신자 휴대폰번호
receiverHP="010-111-222",
# [필수] 공급가액 합계
supplyCostTotal="20000",
# [필수] 세액 합계
taxTotal="2000",
# [필수] 합계금액, 공금가액 합계 + 세액 합계
totalAmount="22000",
# 기재 상 '일련번호' 항목
serialNum="123",
# 기재 상 '비고' 항목
remark1="비고1",
remark2="비고2",
remark3="비고3",
# 사업자등록증 이미지 첨부 여부
businessLicenseYN=False,
# 통장사본 이미지 첨부 여부
bankBookYN=False,
)
# 상세항목(품목) 정보 (배열 길이 제한 없음)
statement.detailList = []
statement.detailList.append(
StatementDetail(
serialNum=1, # 일련번호, 1부터 순차기재
itemName="품목1", # 품목
purchaseDT="20220101", # 거래일자
spec="BOX", # 규격
unitCost="10000", # 단가
qty=1, # 수량
supplyCost="10000", # 공급가액
tax="1000", # 세액
remark="비고", # 비고
spare1="여분1", # 여분1
spare2="여분2", # 여분2
spare3="여분3", # 여분3
spare4="여분4", # 여분4
spare5="여분5", # 여분5
)
)
statement.detailList.append(
StatementDetail(
serialNum=2, # 일련번호, 1부터 순차기재
itemName="품목1", # 품목
purchaseDT="20220101", # 거래일자
spec="BOX", # 규격
unitCost="10000", # 단가
qty=1, # 수량
supplyCost="10000", # 공급가액
tax="1000", # 세액
remark="비고", # 비고
spare1="여분1", # 여분1
spare2="여분2", # 여분2
spare3="여분3", # 여분3
spare4="여분4", # 여분4
spare5="여분5", # 여분5
)
)
# 추가속성정보, 명세서 종류별 추가적인 속성을{key:value}형식의 Dictionary로 정의
statement.propertyBag = {
'Balance': "20000", # 전잔액
'Deposit': "5000", # 입금액
'CBalance': "25000" # 현잔액
}
response = statementService.registIssue(CorpNum, statement, Memo, UserID)
return render(request, 'response.html', {'code': response.code, 'message': response.message})
except PopbillException as PE:
return render(request, 'exception.html', {'code': PE.code, 'message': PE.message})
함수 호출결과 코드와 메시지를 출력하는 "/response.html" 파일을 추가합니다.
<html xmlns=" http://www.w3.org/1999/xhtml ">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Popbill API Test.</title>
</head>
<body>
<div id="content">
<p class="heading1">Response</p>
<br/>
<fieldset class="fieldset1">
<ul>
<li>응답코드 (Response.code) : {{ code }}</li>
<li>응답메시지 (Response.message) : {{ message }}</li>
</ul>
</fieldset>
</div>
</body>
</html>4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 로 숫자 1 반환
- 실패 : PopbillException 으로 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]