POPBill Developers
API Reference

4. 부가기능

4.1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL

  • 세금계산서에 첨부할 인감, 사업자등록증, 통장사본을 등록하는 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
Function GetSealURL(CorpNum As String, UserID As String) As String
  • 인감을 등록한 이후 세금계산서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 세금계산서가 발행됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

Err

4.2. AttachFile - 파일 첨부

  • "임시저장" 상태의 세금계산서에 1개의 파일을 첨부합니다. (최대 5개)
Function AttachFile(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, FilePath As String, Optional UserID As String = "") As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
FilePath String - Y 첨부파일명
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.3. DeleteFile - 첨부파일 삭제

  • "임시저장" 상태의 세금계산서에 첨부된 1개의 파일을 삭제합니다.
  • 파일 식별을 위해 첨부시 할당되는 'FileID'는 함수 [GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
Function DeleteFile(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, FileID As String, Optional UserID As String = "") As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
FileID String 255 Y 팝빌이 첨부파일 관리를 위해 할당하는 식별번호
함수 [GetFiles – 첨부파일 목록 확인]의 리턴값 AttachedFile의 변수 'attachedFile'를 통해 확인 가능
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.4. GetFiles - 첨부파일 목록 확인

  • 세금계산서에 첨부된 파일목록을 확인합니다.
Function GetFiles(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, Optional UserID As String = "") As Collection
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
UserID String 50 N 팝빌회원 아이디
Return

PBAttachFile[ ]

Throws

Err

4.5. SendEmail - 메일 재전송

  • 세금계산서와 관련된 안내 메일을 재전송 합니다.
Function SendEmail(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, Receiver As String, Optional UserID As String = "") As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 이메일 재전송할 세금계산서 문서번호
Receiver String - Y 수신자 이메일주소
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.6. SendSMS - 문자 재전송

  • 세금계산서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
  • 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
Function SendSMS(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, Sender As String, Receiver As String, Contents As String, Optional UserID As String = "") As PBResponse
  • 함수 호출시 포인트가 과금됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
Sender String - Y 발신번호
Receiver String - Y 수신번호
Contents String 90 Y 메시지 내용
최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.7. SendFAX - 팩스 전송

  • 세금계산서를 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
Function SendFax(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, Sender As String, Receiver As String, Optional UserID As String = "") As PBResponse
  • 함수 호출시 포인트가 과금됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
Sender String - Y 발신번호
Receiver String - Y 수신번호
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.8. AttachStatement - 전자명세서 첨부

  • 팝빌 전자명세서 API를 통해 발행한 전자명세서를 세금계산서에 첨부합니다.
Function AttachStatement(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, SubItemCode As Integer, SubMgtKey As String) As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
SubItemCode Integer 3 Y 첨부할 전자명세서의 유형 코드 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
전자명세서 발행시 입력한 값과 동일하게 작성
SubMgtKey String 24 Y 첨부할 전자명세서 문서번호
Return

PBResponse

Throws

Err

4.9. DetachStatement - 전자명세서 첨부해제

  • 세금계산서에 첨부된 전자명세서를 해제합니다.
Function DetachStatement(CorpNum As String, KeyType As MgtKeyType, MgtKey As String, SubItemCode As Integer, SubMgtKey As String) As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
MgtKey String 24 Y 파트너가 할당한 문서번호
SubItemCode Integer 3 Y 첨부해제할 전자명세서의 유형 코드 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
전자명세서 발행시 입력한 값과 동일하게 작성
SubMgtKey String 24 Y 첨부해제할 전자명세서 문서번호
Return

PBResponse

Throws

Err

4.10. AssignMgtKey - 문서번호 할당

  • 팝빌 사이트를 통해 발행하여 문서번호가 할당되지 않은 세금계산서에 문서번호를 할당합니다.
Function AssignMgtKey(CorpNum As String, KeyType As MgtKeyType, itemKey As String, MgtKey As String, Optional UserID As String = "") As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
KeyType MgtKeyType - Y 세금계산서 유형 (택 1)
SELL매출
BUY매입
TRUSTEE위수탁
itemKey String 18 Y 팝빌에서 세금계산서 관리 목적으로 할당한 식별번호
함수 [Search – 목록 조회]를 통하여 PBTIInfo의 'itemKey'를 확인
MgtKey String 24 Y 파트너가 할당한 문서번호
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.11. ListEmailConfig - 세금계산서 알림메일 발송설정 조회

  • 세금계산서 관련 메일 항목에 대한 발송설정을 확인합니다.
Function ListEmailConfig(CorpNum As String, Optional UserID As String = "") As Collection
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID String 50 N 팝빌회원 아이디
Return

PBEmailConfig[ ]

Throws

Err

4.12. UpdateEmailConfig - 세금계산서 알림메일 발송설정 수정

  • 세금계산서 관련 메일 항목에 대한 발송설정을 수정합니다.
Function UpdateEmailConfig(CorpNum As String, emailType As String, sendYN As Boolean, Optional UserID As String = "") As PBResponse
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
emailType String 9 Y 발송 메일 유형 (택 1)
정발행
TAX_ISSUE
공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
TAX_ISSUE_INVOICER
공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
TAX_CHECK
공급자에게 전자세금계산서가 수신확인 되었음을 알려주는 메일
TAX_CANCEL_ISSUE
공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
역발행
TAX_REQUEST
공급자에게 세금계산서를 전자서명 하여 발행을 요청하는 메일
TAX_CANCEL_REQUEST
공급받는자에게 세금계산서가 취소 되었음을 알려주는 메일
TAX_REFUSE
공급받는자에게 세금계산서가 거부 되었음을 알려주는 메일
위수탁 발행
TAX_TRUST_ISSUE
공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_ISSUE_TRUSTEE
수탁자에게 전자세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_ISSUE_INVOICER
공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
TAX_TRUST_CANCEL_ISSUE
공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
TAX_TRUST_CANCEL_ISSUE_INVOICER
공급자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
처리결과
TAX_CLOSEDOWN
거래처의 휴폐업 여부를 확인하여 안내하는 메일
TAX_NTSFAIL_INVOICER
전자세금계산서 국세청 전송실패를 안내하는 메일
정기발송
ETC_CERT_EXPIRATION
팝빌에 등록된 인증서의 만료예정을 안내하는 메일
sendYN Boolean - Y 메일 전송 여부
true전송
false미전송
UserID String 50 N 팝빌회원 아이디
Return

PBResponse

Throws

Err

4.13. GetSendToNTSConfig - 국세청 전송 옵션 설정 상태 확인

Function GetSendToNTSConfig(CorpNum As String, Optional UserID As String = "") As PBSendToNTSConfig
  • 국세청 전송 옵션 설정은 팝빌 사이트 [전자세금계산서] > [환경설정] > [세금계산서 관리] 메뉴에서 설정할 수 있으며, API로 설정은 불가능 합니다.
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID String 50 N 팝빌회원 아이디
Return

PBSendToNTSConfig

Throws

Err