튜토리얼 - SpringBoot
Java 개발환경에서 팝빌 SDK를 추가하고, 전자세금계산서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
1. POPBiLL SDK 추가
섹션 제목: “1. POPBiLL SDK 추가”Popbill SpringBoot Starter 추가를 위해 SpringBoot 프로젝트 “build.gradle” 파일에 dependency를 추가 후 Refresh 합니다.
※ Popbill SpringBoot Starter는 SpringBoot v1.0 이상에서 사용 가능하며 Popbill Java SDK AutoConfiguration을 지원합니다.
dependencies { implementation 'kr.co.linkhub:popbill-spring-boot-starter:1.20.4'}2. POPBiLL SDK 설정
섹션 제목: “2. POPBiLL SDK 설정”SDK 설정을 위해 아래의 코드를 application.yml 파일에 추가합니다.
popbill: # API Key # - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성) # • LinkID: 파트너를 식별하기 위한 고유 식별자 # • SecretKey: API 인증토큰 발급에 사용되는 키 # # TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요. linkId: TESTER secretKey: SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I= # 연동환경(테스트/운영) 설정 # - 연동환경을 테스트 또는 운영으로 설정합니다. # • true: 테스트 환경으로 설정 # • false(default) : 운영 환경으로 설정 # # ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다. isTest: true # 인증토큰 IP 일치 검증 사용 여부 # - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다. # (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치) # • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용 # • false(미사용) : IP 일치 검사를 생략 # # ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용 # 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경 isIpRestrictOnOff: true # 통신 IP 고정 여부 # - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다. # • true(사용) : 고정(Static) IP 사용 # • false(미사용, default) : 가변(Elastic) IP 사용 # # ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다. # (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능) useStaticIp: false # 로컬시스템 시간 사용 여부 # - 현재시각 기준을 설정합니다. # • true(사용, default) : 로컬시스템 시간 사용 # • false(미사용) : 팝빌 서버의 시간을 사용 # # ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다. # ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다. # ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나 # 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다. useLocalTimeYn: true3. RegistIssue 기능 구현
섹션 제목: “3. RegistIssue 기능 구현”① 전자세금계산서 서비스 클래스 빈 객체 추가를 위해 @Autowired 어노테이션과 RegistIssue 함수 호출 코드를 추가합니다.
import java.util.ArrayList;
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;
import com.popbill.api.IssueResponse;import com.popbill.api.PopbillException;import com.popbill.api.TaxinvoiceService;import com.popbill.api.taxinvoice.Taxinvoice;import com.popbill.api.taxinvoice.TaxinvoiceAddContact;import com.popbill.api.taxinvoice.TaxinvoiceDetail;
@Controllerpublic class TaxinvoiceServiceController {
@Autowired private TaxinvoiceService taxinvoiceService;
@RequestMapping(value = "registIssue", method = RequestMethod.GET) public String registIssue(Model m) {
// 팝빌회원 사업자번호 String CorpNum = "1234567890";
// 전자세금계산서 정보 Taxinvoice taxinvoice = new Taxinvoice();
// 발행형태, {정발행, 역발행, 위수탁} 중 기재 taxinvoice.setIssueType("정발행");
// 과세형태, {과세, 영세, 면세} 중 기재 taxinvoice.setTaxType("과세");
// 과금방향, {정과금, 역과금} 중 기재 // └ 정과금 = 공급자 과금 , 역과금 = 공급받는자 과금 // -'역과금'은 역발행 세금계산서 발행 시에만 이용가능 taxinvoice.setChargeDirection("정과금");
// 일련번호 taxinvoice.setSerialNum("123");
// 책번호 '권' 항목 taxinvoice.setKwon((short) 1);
// 책번호 '호' 항목 taxinvoice.setHo((short) 1);
// 작성일자, 날짜형식(yyyyMMdd) taxinvoice.setWriteDate("20250711");
// 영수/청구, {영수, 청구, 없음} 중 기재 taxinvoice.setPurposeType("영수");
// 공급가액 합계 taxinvoice.setSupplyCostTotal("100000");
// 세액 합계 taxinvoice.setTaxTotal("10000");
// 합계금액, 공급가액 + 세액 taxinvoice.setTotalAmount("110000");
// 현금 taxinvoice.setCash("");
// 수표 taxinvoice.setChkBill("");
// 외상 taxinvoice.setCredit("");
// 어음 taxinvoice.setNote("");
// 비고 // {invoiceeType}이 "외국인" 이면 remark1 필수 // - 외국인 등록번호 또는 여권번호 입력 taxinvoice.setRemark1("비고1"); taxinvoice.setRemark2("비고2"); taxinvoice.setRemark3("비고3");
/*************************************************************************** * 공급자 정보 ****************************************************************************/
// 공급자 문서번호, 1~24자리 (숫자, 영문, '-', '_') 조합으로 사업자 별로 중복되지 않도록 구성 taxinvoice.setInvoicerMgtKey("20250711-MVC001");
// 공급자 사업자번호 (하이픈 '-' 제외 10 자리) taxinvoice.setInvoicerCorpNum(CorpNum);
// 공급자 종사업장 식별번호, 필요시 기재. 형식은 숫자 4자리. taxinvoice.setInvoicerTaxRegID("");
// 공급자 상호 taxinvoice.setInvoicerCorpName("공급자 상호");
// 공급자 대표자 성명 taxinvoice.setInvoicerCEOName("공급자 대표자 성명");
// 공급자 주소 taxinvoice.setInvoicerAddr("공급자 주소");
// 공급자 업태 taxinvoice.setInvoicerBizType("공급자 업태,업태2");
// 공급자 종목 taxinvoice.setInvoicerBizClass("공급자 종목");
// 공급자 담당자 성명 taxinvoice.setInvoicerContactName("공급자 담당자 성명");
// 공급자 담당자 부서명 taxinvoice.setInvoicerDeptName("공급자 담당자 부서명");
// 공급자 담당자 연락처 taxinvoice.setInvoicerTEL("070-7070-0707");
// 공급자 담당자 휴대폰 taxinvoice.setInvoicerHP("010-000-2222");
// 공급자 담당자 메일 taxinvoice.setInvoicerEmail("test@test.com");
// 공급자 알림문자 전송 여부 (true / false 중 택 1) // └ true = 전송 , false = 미전송 // └ 공급받는자 (주)담당자 휴대폰번호 {invoiceeHP1} 값으로 문자 전송 // - 전송 시 포인트 차감되며, 전송실패시 환불처리 taxinvoice.setInvoicerSMSSendYN(false);
/*************************************************************************** * 공급받는자 정보 ****************************************************************************/
// [역발행시 필수] 공급받는자 문서번호, 1~24자리 (숫자, 영문, '-', '_') 를 조합하여 사업자별로 중복되지 않도록 구성 taxinvoice.setInvoiceeMgtKey("");
// 공급받는자 유형, [사업자, 개인, 외국인] 중 기재 taxinvoice.setInvoiceeType("사업자");
// 공급받는자 등록번호 // - {invoiceeType}이 "사업자" 인 경우, 사업자번호 (하이픈 ('-') 제외 10자리) // - {invoiceeType}이 "개인" 인 경우, 주민등록번호 (하이픈 ('-') 제외 13자리) // - {invoiceeType}이 "외국인" 인 경우, "9999999999999" (하이픈 ('-') 제외 13자리) taxinvoice.setInvoiceeCorpNum("8888888888");
// 공급받는자 종사업장 식별번호, 필요시 숫자4자리 기재 taxinvoice.setInvoiceeTaxRegID("");
// 공급받는자 상호 taxinvoice.setInvoiceeCorpName("공급받는자 상호");
// 공급받는자 대표자 성명 taxinvoice.setInvoiceeCEOName("공급받는자 대표자 성명");
// 공급받는자 주소 taxinvoice.setInvoiceeAddr("공급받는자 주소");
// 공급받는자 업태 taxinvoice.setInvoiceeBizType("공급받는자 업태");
// 공급받는자 종목 taxinvoice.setInvoiceeBizClass("공급받는자 종목");
// 공급받는자 담당자 성명 taxinvoice.setInvoiceeContactName1("공급받는자 담당자 성명");
// 공급받는자 담당자 부서명 taxinvoice.setInvoiceeDeptName1("공급받는자 담당자 부서명");
// 공급받는자 담당자 연락처 taxinvoice.setInvoiceeTEL1("070-111-222");
// 공급받는자 담당자 휴대폰 taxinvoice.setInvoiceeHP1("010-111-222");
// 공급받는자 담당자 메일 // 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로, // 실제 거래처의 메일주소가 기재되지 않도록 주의 taxinvoice.setInvoiceeEmail1("test@invoicee.com");
// 공급받는자 알림문자 전송 여부 (true / false 중 택 1) // └ true = 전송 , false = 미전송 // └ 공급자 담당자 휴대폰 {invoicerHP} 값으로 문자 전송 // - 전송 시 포인트 차감되며, 전송실패시 환불처리 taxinvoice.setInvoiceeSMSSendYN(false);
/*************************************************************************** * 수정세금계산서 정보 (수정세금계산서 작성시에만 기재) ****************************************************************************/
// 수정 사유코드, 수정사유에 따라 1~6 중 선택기재. taxinvoice.setModifyCode(null);
// 당초 국세청승인번호 taxinvoice.setOrgNTSConfirmNum(null);
// 팝빌에 등록된 사업자등록증 첨부 여부 (true / false 중 택 1) // └ true = 첨부 , false = 미첨부(기본값) // - 팝빌 사이트 또는 인감 및 첨부문서 등록 팝업 URL (GetSealURL API) 함수를 이용하여 등록 taxinvoice.setBusinessLicenseYN(false);
// 팝빌에 등록된 통장사본 첨부 여부 (true / false 중 택 1) // └ true = 첨부 , false = 미첨부(기본값) // - 팝빌 사이트 또는 인감 및 첨부문서 등록 팝업 URL (GetSealURL API) 함수를 이용하여 등록 taxinvoice.setBankBookYN(false);
/*************************************************************************** * 품목 상세정보 ****************************************************************************/
taxinvoice.setDetailList(new ArrayList<TaxinvoiceDetail>());
TaxinvoiceDetail detail = new TaxinvoiceDetail();
detail.setSerialNum((short) 1); // 일련번호, 1부터 순차기재 detail.setPurchaseDT("20250711"); // 거래일자 detail.setItemName("품명"); // 품명 detail.setSpec("규격"); // 규격 detail.setQty("1"); // 수량 detail.setUnitCost("50000"); // 단가 detail.setSupplyCost("50000"); // 공급가액 detail.setTax("5000"); // 세액 detail.setRemark("품목비고"); // 비고
taxinvoice.getDetailList().add(detail);
detail = new TaxinvoiceDetail();
detail.setSerialNum((short) 2); detail.setPurchaseDT("20250711"); detail.setItemName("품명2"); detail.setSpec("규격"); detail.setQty("1"); detail.setUnitCost("50000"); detail.setSupplyCost("50000"); detail.setTax("5000"); detail.setRemark("품목비고2");
taxinvoice.getDetailList().add(detail);
/*************************************************************************** * 공급받는자 추가담당자 정보 * - 세금계산서 발행 안내 메일을 수신받을 공급받는자 담당자가 다수인 경우 담당자 정보를 * - 추가하여 발행 안내메일을 다수에게 전송할 수 있습니다. (최대 5명) ****************************************************************************/
taxinvoice.setAddContactList(new ArrayList<TaxinvoiceAddContact>());
TaxinvoiceAddContact addContact = new TaxinvoiceAddContact();
addContact.setSerialNum(1); // 일련번호, (1부터 순차적으로 입력 (최대 5)) addContact.setContactName("추가 담당자 성명"); // 담당자 성명 addContact.setEmail("test2@test.com"); // 메일
taxinvoice.getAddContactList().add(addContact);
// 거래명세서 동시작성여부 (true / false 중 택 1) // └ true = 사용 , false = 미사용 // - 미입력 시 기본값 false 처리 Boolean WriteSpecification = false;
// 세금계산서 상태 이력을 관리하기 위한 메모 String Memo = "즉시발행 메모";
// 지연발행 가능여부 (true / false 중 택 1) // └ true = 가능 , false = 불가능 // - 미입력 시 기본값 false 처리 // - 발행마감일이 지난 세금계산서를 발행하는 경우, 가산세가 부과될 수 있습니다. Boolean ForceIssue = false;
// 거래명세서 문서번호, {writeSpecification} = true인 경우, 거래명세서 문서번호 할당 // - 미입력시 기본값 세금계산서 문서번호와 동일하게 할당 String DealInvoiceKey = null;
// 세금계산서 발행 안내메일 제목 String EmailSubject = "";
// 팝빌회원 아이디 String UserID = "testkorea";
try {
IssueResponse response = taxinvoiceService.registIssue(CorpNum, taxinvoice, WriteSpecification, Memo, ForceIssue, DealInvoiceKey, EmailSubject, UserID);
m.addAttribute("Response", response);
} catch (PopbillException e) { // 예외 발생 시, e.getCode() 로 오류 코드를 확인하고, e.getMessage()로 오류 메시지를 확인합니다. System.out.println("오류 코드" + e.getCode()); System.out.println("오류 메시지" + e.getMessage()); }
return "response"; }}② 함수 호출결과 코드와 메시지를 출력하는 response.html 파일을 추가합니다.
<html xmlns:th="http://www.thymeleaf.org"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <title>Popbill SDK Response</title> </head>
<body> <fieldset> <ul> <li>code (응답코드) : <span th:text="${Response.code}"></span></li> <li>message (응답메시지) : <span th:text="${Response.message}"></span></li> <li>ntsConfirmNum (국세청승인번호) : <span th:text="${Response.ntsConfirmNum}"></span></li> </ul> </fieldset> </body></html>4. API 응답결과 확인
섹션 제목: “4. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | code : 1 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |