4. 부가기능
4.1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL
- 전자명세서에 첨부할 인감, 사업자등록증, 통장사본을 등록하는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getSealURL(corpNum, userID)- 인감을 등록한 이후 전자명세서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 전자명세서가 발행됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
4.2. AttachFile - 파일 첨부
- "임시저장" 상태의 명세서에 1개의 파일을 첨부합니다. (최대 5개)
def attachFile(corpNum, itemCode, mgtKey, filePath, userID ='')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| filePath | String | - | Y | 첨부파일 경로 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.3. DeleteFile - 첨부파일 삭제
- "임시저장" 상태의 전자명세서에 첨부된 1개의 파일을 삭제합니다.
- 파일 식별을 위해 첨부시 할당되는 'FileID'는 함수[GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
def deleteFile(corpNum, itemCode, mgtKey, fileID, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| fileID | String | 255 | Y |
팝빌이 첨부파일 관리를 위해 할당하는 식별번호
함수 [GetFiles – 첨부파일 목록 확인]의 리턴값 중 'attachedFile' 필드 참조
|
|
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.4. GetFiles - 첨부파일 목록 확인
- 전자명세서에 첨부된 파일목록을 확인합니다.
def getFiles(corpNum, itemCode, mgtKey, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.5. SendEmail - 메일 재전송
- "승인대기", "발행완료" 상태의 전자명세서와 관련된 발행 안내 메일을 재전송 합니다.
def sendEmail(corpNum, itemCode, mgtKey, receiverMail, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 이메일 재전송할 전자명세서 문서번호 | |
| receiverMail | String | - | Y | 수신자 이메일주소 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.6. SendSMS - 문자 재전송
- 전자명세서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
- 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
def sendSMS(corpNum, itemCode, mgtKey, senderNum, receiverNum, contents, userID = '')
유의사항
- 함수 호출시 포인트가 과금됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| senderNum | String | - | Y | 발신번호 | |
| receiverNum | String | - | Y | 수신번호 | |
| contents | String | 90 | Y |
메시지 내용
최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
|
|
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.7. SendFAX - 팩스 전송
- 전자명세서를 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
def sendFax(corpNum, itemCode, mgtKey, senderNum, receiverNum, userID = '')
유의사항
- 함수 호출시 포인트가 과금됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| senderNum | String | - | Y | 발신번호 | |
| receiverNum | String | - | Y | 수신번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.8. FAXSend - 선팩스 전송
- 전자명세서를 팩스로 전송하는 함수로, 팝빌에 데이터를 저장하는 과정이 없습니다.
- 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
def faxSend(corpNum, statement, sendNum, receiveNum, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| statement | Statement | - | Y | 전자명세서 객체정보 | |
| sendNum | String | - | Y |
발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
|
|
| receiveNum | String | - | Y | 수신번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.9. AttachStatement - 전자명세서 첨부
- 하나의 전자명세서에 다른 전자명세서를 첨부합니다.
def attachStatement(corpNum, itemCode, mgtKey, subItemCode, subMgtKey, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| subItemCode | Integer | 3 | Y |
첨부할 전자명세서 문서유형 (택 1)
|
|
| subMgtKey | String | 24 | Y | 첨부할 전자명세서 문서번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.10. DetachStatement - 전자명세서 첨부해제
- 하나의 전자명세서에 첨부된 다른 전자명세서를 해제합니다.
def detachStatement(corpNum, itemCode, mgtKey, subItemCode, subMgtKey, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| itemCode | Integer | 3 | Y |
전자명세서 문서유형 (택 1)
|
|
| mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
| subItemCode | Integer | 3 | Y |
첨부해제할 전자명세서 문서유형 (택 1)
|
|
| subMgtKey | String | 24 | Y | 첨부해제할 전자명세서 문서번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.11. ListEmailConfig - 전자명세서 알림메일 발송설정 조회
- 전자명세서 관련 메일 항목에 대한 발송설정을 확인합니다.
def listEmailConfig(corpNum, userID ='')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.12. UpdateEmailConfig - 전자명세서 알림메일 발송설정 수정
- 전자명세서 관련 메일 항목에 대한 발송설정을 수정합니다.
def updateEmailConfig(corpNum, emailType, sendYN, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| emailType | String | 9 | Y |
전송 메일 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일 |
|
| sendYN | Boolean | - | Y | 전송 여부 | |
| userID | String | 50 | N | 팝빌회원 아이디 |