POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
API Reference
전자명세서
Node.js
API Reference 전자명세서 Node.js 부가기능

4. 부가기능

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

  • 전자명세서에 첨부될 인감, 사업자등록증, 통장사본을 등록하는 팝업 URL을 반환합니다.
  • 권장 사이즈 : width = 805px / height = 741px
  • 반환되는 URL은 30초 동안만 사용이 가능합니다.
  • 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
statementService.getSealURL(CorpNum, UserID, success, error)
  • 인감을 등록한 이후 전자명세서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 전자명세서가 발행됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

string - 요청에 대한 응답 URL

Throws

PopbillException

4.2. AttachFile - 파일 첨부

  • "임시저장" 상태의 명세서에 1개의 파일을 첨부합니다. (최대 5개)
statementService.attachFile(CorpNum, ItemCode, MgtKey, DisplayName, FilePath, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
DisplayName string 255 Y 첨부파일명
FilePath string - Y 첨부파일 경로
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.3. DeleteFile - 첨부파일 삭제

  • "임시저장" 상태의 전자명세서에 첨부된 1개의 파일을 삭제합니다.
  • 파일 식별을 위해 첨부시 할당되는 'FileID'는 함수[GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
statementService.deleteFile(CorpNum, ItemCode, MgtKey, FileID, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
FileID string 255 Y 팝빌이 첨부파일 관리를 위해 할당하는 식별번호
함수 [GetFiles – 첨부파일 목록 확인]의 리턴값 중 'attachedFile' 필드 참조
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

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

  • 전자명세서에 첨부된 파일목록을 확인합니다.
statementService.getFiles(CorpNum, ItemCode, MgtKey, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

AttachedFile[ ]

Throws

PopbillException

4.5. SendEmail - 메일 재전송

  • "승인대기", "발행완료" 상태의 전자명세서와 관련된 발행 안내 메일을 재전송 합니다.
statementService.sendEmail(CorpNum, ItemCode, MgtKey, Receiver, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 이메일 재전송할 전자명세서 문서번호
Receiver string - Y 수신자 이메일주소
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.6. SendSMS - 문자 재전송

  • 전자명세서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
  • 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
statementService.sendSMS(CorpNum, ItemCode, MgtKey, Sender, Receiver, Contents, UserID, success, error)
유의사항
  • 함수 호출시 포인트가 과금됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
Sender string - Y 발신번호
Receiver string - Y 수신번호
Contents string 90 Y 메시지 내용
최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.7. SendFAX - 팩스 전송

  • 전자명세서를 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
statementService.sendFAX(CorpNum, ItemCode, MgtKey, Sender, Receiver, UserID, success, error)
유의사항
  • 함수 호출시 포인트가 과금됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
Sender string - Y 발신번호
Receiver string - Y 수신번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.8. FAXSend - 선팩스 전송

  • 전자명세서를 팩스로 전송하는 함수로, 팝빌에 데이터를 저장하는 과정이 없습니다.
  • 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
statementService.FAXSend(CorpNum, Statement, sendNum, receiveNum, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Statement Statement - Y 전자명세서 객체정보
sendNum string - Y 발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
receiveNum string - Y 수신번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.9. AttachStatement - 전자명세서 첨부

  • 하나의 전자명세서에 다른 전자명세서를 첨부합니다.
statementService.attachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
SubItemCode number 3 Y 첨부할 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
SubMgtKey string 24 Y 첨부할 전자명세서 문서번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

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

  • 하나의 전자명세서에 첨부된 다른 전자명세서를 해제합니다.
statementService.detachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ItemCode number 3 Y 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
MgtKey string 24 Y 파트너가 할당한 문서번호
SubItemCode number 3 Y 첨부해제할 전자명세서 문서유형 (택 1)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
SubMgtKey string 24 Y 첨부해제할 전자명세서 문서번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

4.11. ListEmailConfig - 전자명세서 알림메일 발송설정 조회

  • 전자명세서 관련 메일 항목에 대한 발송설정을 확인합니다.
statementService.listEmailConfig(CorpNum, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

EmailSendConfig[ ]

Throws

PopbillException

4.12. UpdateEmailConfig - 전자명세서 알림메일 발송설정 수정

  • 전자명세서 관련 메일 항목에 대한 발송설정을 수정합니다.
statementService.updateEmailConfig(CorpNum, EmailType, SendYN, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
EmailType string - Y 전송 메일 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
SendYN boolean - Y 전송 여부
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException