튜토리얼 - Laravel

PHP 개발환경에서 팝빌 SDK를 추가하고, 전자세금계산서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 PHP SDK를 추가하기 위해 Laravel 프로젝트의 composer.json 파일의 require 필드 오브젝트에 Popbill SDK 정보를 추가후 composer update 커멘드를 실행하여 popbill 패키지를 설치합니다.

 {
   "name" : "laravel/laravel" ,
   "type" : "project" ,
   "description" : "The Laravel Framework." ,
   "keywords" : [
     "framework" ,
     "laravel"
   ],
   "license" : "MIT" ,
   "require" : {
     "php" : "^7.1.3" ,
     "fideloper/proxy" : "^4.0" ,
     "laravel/framework" : "5.7.*" ,
     "laravel/tinker" : "^1.0" ,
     "linkhub/popbill" : "^1.68.2"
   },
   // 생략..

2. POPBiLL SDK 설정

팝빌 SDK의 환경설정을 위해 laravel 프로젝트 config 폴더에 popbill.php 파일을 추가합니다.

<?php
return [
  // API Key
  // - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
  // • LinkID: 파트너를 식별하기 위한 고유 식별자
  // • SecretKey: API 인증토큰 발급에 사용되는 키
  //
  // TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
  'LinkID' => 'TESTER',
  'SecretKey' => 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=',

  // 통신방식 기본은 CURL , PHP curl 모듈 사용에 문제가 있을 경우 STREAM 기재가능.
  // STREAM 사용시에는 php.ini의 allow_url_fopen = on 으로 설정해야함.
  'LINKHUB_COMM_MODE' => 'CURL',

  // 연동환경(테스트/운영) 설정
  // - 연동환경을 테스트 또는 운영으로 설정합니다.
  // • 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,
];

Window 계열 OS 환경에서 APM을 통해 개발환경을 구성한 경우 LINKHUB_COMM_MODE 상수의 값을 “STREAM”으로 변경합니다.

3. RegistIssue 기능 구현

Controller를 추가하고 클래스 생성자(__construct)에 팝빌 서비스 클래스 초기화 코드와 RegistIssue 함수를 추가합니다.

<?php
namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Linkhub\LinkhubException;
use Linkhub\Popbill\JoinForm;
use Linkhub\Popbill\CorpInfo;
use Linkhub\Popbill\ContactInfo;
use Linkhub\Popbill\ChargeInfo;
use Linkhub\Popbill\PopbillException;

use Linkhub\Popbill\PopbillTaxinvoice;
use Linkhub\Popbill\TIENumMgtKeyType;
use Linkhub\Popbill\Taxinvoice;
use Linkhub\Popbill\TaxinvoiceDetail;
use Linkhub\Popbill\TaxinvoiceAddContact;


class TestController extends Controller
{
  public function __construct() {

    // 통신방식 설정
    define('LINKHUB_COMM_MODE', config('popbill.LINKHUB_COMM_MODE'));

    // 세금계산서 서비스 클래스 초기화
    $this->PopbillTaxinvoice = new PopbillTaxinvoice(config('popbill.LinkID'), config('popbill.SecretKey'));

    // 연동환경(테스트/운영) 설정
    // - 연동환경을 테스트 또는 운영으로 설정합니다.
    // • true: 테스트 환경으로 설정
    // • false(default) : 운영 환경으로 설정
    //
    // ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게  환경 전환(테스트<->운영)이 가능합니다.
    $this->PopbillTaxinvoice->IsTest(config('popbill.IsTest'));

    // 인증토큰 IP 일치 검증 사용 여부
    // - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
    //   (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
    // • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
    // • false(미사용) : IP 일치 검사를 생략
    //
    // ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
    //   예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
    $this->PopbillTaxinvoice->IPRestrictOnOff(config('popbill.IPRestrictOnOff'));

    // 통신 IP 고정 여부
    // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
    // • true(사용) : 고정(Static) IP 사용
    // • false(미사용, default) : 가변(Elastic) IP 사용
    //
    // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
    //   (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
    $this->PopbillTaxinvoice->UseStaticIP(config('popbill.UseStaticIP'));

    // 로컬시스템 시간 사용 여부
    // - 현재시각 기준을 설정합니다.
    // • true(사용, default) : 로컬시스템 시간 사용
    // • false(미사용) : 팝빌 서버의 시간을 사용
    //
    // ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
    // ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
    // ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
    //   서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.
    $this->PopbillTaxinvoice->UseLocalTimeYN(config('popbill.UseLocalTimeYN'));
  }

  public function RegistIssue(){

    // 팝빌회원 사업자번호, '-' 제외 10자리
    $testCorpNum = '1234567890';

    // 세금계산서 문서번호
    // - 최대 24자리 숫자, 영문, '-', '_' 조합으로 사업자별로 중복되지 않도록 구성
    $invoicerMgtKey = '20250314-001';

    /************************************************************
     *                        세금계산서 정보
     ************************************************************/
    // 세금계산서 객체 생성
    $Taxinvoice = new Taxinvoice();

    // [필수] 작성일자, 형식(yyyyMMdd) 예)20250101
    $Taxinvoice->writeDate = '20250314';

    // [필수] 발행형태, '정발행', '역발행', '위수탁' 중 기재
    $Taxinvoice->issueType = '정발행';

    // [필수] 과금방향,
    // - '정과금'(공급자 과금), '역과금'(공급받는자 과금) 중 기재, 역과금은 역발행시에만 가능.
    $Taxinvoice->chargeDirection = '정과금';

    // [필수] '영수', '청구', '없음' 중 기재
    $Taxinvoice->purposeType = '영수';

    // [필수] 과세형태, '과세', '영세', '면세' 중 기재
    $Taxinvoice->taxType = '과세';

    /************************************************************
     *                         공급자 정보
     ************************************************************/
    // [필수] 공급자 사업자번호
    $Taxinvoice->invoicerCorpNum = $testCorpNum;

    // 공급자 종사업장 식별번호, 4자리 숫자 문자열
    $Taxinvoice->invoicerTaxRegID = '';

    // [필수] 공급자 상호
    $Taxinvoice->invoicerCorpName = '공급자상호';

    // [필수] 공급자 문서번호, 최대 24자리 숫자, 영문, '-', '_' 조합으로 사업자별로 중복되지 않도록 구성
    $Taxinvoice->invoicerMgtKey = $invoicerMgtKey;

    // [필수] 공급자 대표자성명
    $Taxinvoice->invoicerCEOName = '공급자 대표자성명';

    // 공급자 주소
    $Taxinvoice->invoicerAddr = '공급자 주소';

    // 공급자 종목
    $Taxinvoice->invoicerBizClass = '공급자 종목';

    // 공급자 업태
    $Taxinvoice->invoicerBizType = '공급자 업태';

    // 공급자 담당자 성명
    $Taxinvoice->invoicerContactName = '공급자 담당자성명';

    // 공급자 담당자 메일주소
    $Taxinvoice->invoicerEmail = 'tester@test.com';

    // 공급자 담당자 연락처
    $Taxinvoice->invoicerTEL = '070-4304-2991';

    // 공급자 휴대폰 번호
    $Taxinvoice->invoicerHP = '010-111-222';

    // 발행시 알림문자 전송여부 (정발행에서만 사용가능)
    // - 공급받는자 주)담당자 휴대폰번호(invoiceeHP1)로 전송
    // - 전송시 포인트가 차감되며 전송실패하는 경우 포인트 환불처리
    $Taxinvoice->invoicerSMSSendYN = false;

    /************************************************************
     *                      공급받는자 정보
     ************************************************************/

    // [필수] 공급받는자 유형, '사업자', '개인', '외국인' 중 기재
    $Taxinvoice->invoiceeType = '사업자';

    // [필수] 공급받는자 사업자번호
    $Taxinvoice->invoiceeCorpNum = '8888888888';

    // 공급받는자 종사업장 식별번호, 4자리 숫자 문자열
    $Taxinvoice->invoiceeTaxRegID = '';

    // [필수] 공급받는자 상호
    $Taxinvoice->invoiceeCorpName = '공급받는자 상호';

    // [역발행시 필수] 공급받는자 문서번호, 최대 24자리 숫자, 영문, '-', '_' 조합으로 사업자별로 중복되지 않도록 구성
    $Taxinvoice->invoiceeMgtKey = '';

    // [필수] 공급받는자 대표자성명
    $Taxinvoice->invoiceeCEOName = '공급받는자 대표자성명';

    // 공급받는자 주소
    $Taxinvoice->invoiceeAddr = '공급받는자 주소';

    // 공급받는자 업태
    $Taxinvoice->invoiceeBizType = '공급받는자 업태';

    // 공급받는자 종목
    $Taxinvoice->invoiceeBizClass = '공급받는자 종목';

    // 공급받는자 담당자 성명
    $Taxinvoice->invoiceeContactName1 = '공급받는자 담당자성명';

    // 공급받는자 담당자 메일주소
    // 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
    // 실제 거래처의 메일주소가 기재되지 않도록 주의
    $Taxinvoice->invoiceeEmail1 = 'test@test.com';

    // 공급받는자 담당자 연락처
    $Taxinvoice->invoiceeTEL1 = '070-111-222';

    // 공급받는자 담당자 휴대폰 번호
    $Taxinvoice->invoiceeHP1 = '010-111-222';

    /************************************************************
     *                       세금계산서 기재정보
     ************************************************************/
    // [필수] 공급가액 합계
    $Taxinvoice->supplyCostTotal = '200000';

    // [필수] 세액 합계
    $Taxinvoice->taxTotal = '20000';

    // [필수] 합계금액, (공급가액 합계 + 세액 합계)
    $Taxinvoice->totalAmount = '220000';

    // 기재상 '일련번호'항목
    $Taxinvoice->serialNum = '123';

    // 기재상 '현금'항목
    $Taxinvoice->cash = '';

    // 기재상 '수표'항목
    $Taxinvoice->chkBill = '';

    // 기재상 '어음'항목
    $Taxinvoice->note = '';

    // 기재상 '외상'항목
    $Taxinvoice->credit = '';

    // 기재상 '비고' 항목
    $Taxinvoice->remark1 = '비고1';
    $Taxinvoice->remark2 = '비고2';
    $Taxinvoice->remark3 = '비고3';

    // 기재상 '권' 항목, 최대값 32767
    // 미기재시 $Taxinvoice->kwon = null;
    $Taxinvoice->kwon = 1;

    // 기재상 '호' 항목, 최대값 32767
    // 미기재시 $Taxinvoice->ho = null;
    $Taxinvoice->ho = 1;

    // 사업자등록증 이미지파일 첨부여부
    $Taxinvoice->businessLicenseYN = false;

    // 통장사본 이미지파일 첨부여부
    $Taxinvoice->bankBookYN = false;

    /************************************************************
     *                     수정세금계산서 기재정보
     * - 수정세금계산서 관련 정보는 연동매뉴얼 또는 개발가이드 링크 참조
     * - [참고] 수정세금계산서 작성방법 안내 - http://blog.linkhubcorp.com/650
     ************************************************************/

    // [수정세금계산서 작성시 필수] 수정사유코드, 수정사유에 따라 1~6중 선택기재
    //$Taxinvoice->modifyCode = '';

    // [수정세금계산서 작성시 필수] 수정세금계산서 작성시 당초 국세청승인번호 기재
    //$Taxinvoice->orgNTSConfirmNum = '';

    /************************************************************
     *                       상세항목(품목) 정보
     ************************************************************/
    $Taxinvoice->detailList = array();
    $Taxinvoice->detailList[] = new TaxinvoiceDetail();
    $Taxinvoice->detailList[0]->serialNum = 1;  // [상세항목 배열이 있는 경우 필수] 일련번호 1~99까지 순차기재,
    $Taxinvoice->detailList[0]->purchaseDT = '20250314';  // 거래일자
    $Taxinvoice->detailList[0]->itemName = '품목명1번'; // 품명
    $Taxinvoice->detailList[0]->spec = '';  // 규격
    $Taxinvoice->detailList[0]->qty = ''; // 수량
    $Taxinvoice->detailList[0]->unitCost = '';  // 단가
    $Taxinvoice->detailList[0]->supplyCost = '100000';  // 공급가액
    $Taxinvoice->detailList[0]->tax = '10000';  // 세액
    $Taxinvoice->detailList[0]->remark = '';  // 비고

    $Taxinvoice->detailList[] = new TaxinvoiceDetail();
    $Taxinvoice->detailList[1]->serialNum = 2;  // [상세항목 배열이 있는 경우 필수] 일련번호 1~99까지 순차기재,
    $Taxinvoice->detailList[1]->purchaseDT = '20250314';  // 거래일자
    $Taxinvoice->detailList[1]->itemName = '품목명2번'; // 품명
    $Taxinvoice->detailList[1]->spec = '';  // 규격
    $Taxinvoice->detailList[1]->qty = ''; // 수량
    $Taxinvoice->detailList[1]->unitCost = '';  // 단가
    $Taxinvoice->detailList[1]->supplyCost = '100000';  // 공급가액
    $Taxinvoice->detailList[1]->tax = '10000';  // 세액
    $Taxinvoice->detailList[1]->remark = '';  // 비고

    /************************************************************
     *                      추가담당자 정보
     * - 세금계산서 발행안내 메일을 수신받을 공급받는자 담당자가 다수인 경우
     * 추가 담당자 정보를 등록하여 발행안내메일을 다수에게 전송할 수 있습니다. (최대 5명)
     ************************************************************/
    $Taxinvoice->addContactList = array();
    $Taxinvoice->addContactList[] = new TaxinvoiceAddContact();
    $Taxinvoice->addContactList[0]->serialNum = 1;  // 일련번호 1부터 순차기재
    $Taxinvoice->addContactList[0]->email = 'test@test.com';  // 이메일주소
    $Taxinvoice->addContactList[0]->contactName  = '팝빌담당자';  // 담당자명

    $Taxinvoice->addContactList[] = new TaxinvoiceAddContact();
    $Taxinvoice->addContactList[1]->serialNum = 2;  // 일련번호 1부터 순차기재
    $Taxinvoice->addContactList[1]->email = 'test@test.com';  // 이메일주소
    $Taxinvoice->addContactList[1]->contactName  = '링크허브'; // 담당자명

    // 팝빌회원 아이디
    $testUserID = 'testkorea';

    // 거래명세서 동시작성 여부
    $writeSpecification = false;

    // 지연발행 강제여부
    $forceIssue = false;

    // 즉시 발행 메모
    $memo = '즉시 발행 메모';

    // 안내메일 제목, 미기재시 기본제목으로 전송
    $emailSubject = null;

    // 거래명세서 동시작성시 명세서 관리번호
    // - 최대 24자리 숫자, 영문, '-', '_' 조합으로 사업자별로 중복되지 않도록 구성
    $dealInvoiceMgtKey = null;

    try {
        $result = $this->PopbillTaxinvoice->RegistIssue($testCorpNum, $Taxinvoice, $testUserID,
            $writeSpecification, $forceIssue, $memo, $emailSubject, $dealInvoiceMgtKey);

        $code = $result->code;
        $message = $result->message;
        $ntsConfirmNum = $result->ntsConfirmNum;
    }
    catch(PopbillException $pe) {
        $code = $pe->getCode();
        $message = $pe->getMessage();
        $ntsConfirmNum = null;
    }

    return view('PResponse', ['code' => $code, 'message' => $message, 'ntsConfirmNum' => $ntsConfirmNum]);
  }
}

호출 결과를 출력하는 페이지(PResponse.blade.php)를 resources/views/에 추가합니다.

<html xmlns=" http://www.w3.org/1999/xhtml ">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>Popbill Taxinvoice Response.</title>
  </head>
  <body>
    <div>
      <p>Response</p>
      <br/>
      <fieldset>
        <ul>
          <li>code (응답코드) : {{ $code }}</li>
          <li>message (응답메시지) : {{ $message }}</li>
          <li>ntsConfirmNum (국세청승인번호) : {{ $ntsConfirmNum }}</li>
        </ul>
      </fieldset>
    </div>
  </body>
</html>

아래 코드를 참고하여 routes/web.php 파일에 route 부분을 입력합니다.

<?php
// 생략..

Route::get('/RegistIssue ', 'TestController@RegistIssue');

// 생략..

4. API 응답결과 확인

API 호출 응답결과는 다음과 같습니다.

구분	응답
성공	code : 1
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지