4. 부가기능
4.1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL
- 세금계산서에 첨부할 인감, 사업자등록증, 통장사본을 등록하는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getSealURL(CorpNum, UserID):
- 인감을 등록한 이후 세금계산서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 세금계산서가 발행됩니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
str - 요청에 대한 응답 URL
Throws
4.2. AttachFile - 파일 첨부
- "임시저장" 상태의 세금계산서에 1개의 파일을 첨부합니다. (최대 5개)
def attachFile(CorpNum, MgtKeyType, MgtKey, FilePath, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
FilePath | str | - | O | 첨부파일 경로 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.3. DeleteFile - 첨부파일 삭제
- "임시저장" 상태의 세금계산서에 첨부된 1개의 파일을 삭제합니다.
- 파일 식별을 위해 첨부시 부여되는 'FileID'는 함수 [GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
def deleteFile(CorpNum, MgtKeyType, MgtKey, FileID, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
FileID | str | 255 | O |
팝빌이 첨부파일 관리를 위해 할당하는 식별번호
└ 함수 [GetFiles – 첨부파일 목록 확인]의 리턴값 AttachedFile의 변수 'attachedFile'를 통해 확인 가능 |
|
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.4. GetFiles - 첨부파일 목록 확인
- 세금계산서에 첨부된 파일목록을 확인합니다.
def getFiles(CorpNum, MgtKeyType, MgtKey):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 |
Return
Throws
4.5. SendEmail - 메일 재전송
- 세금계산서와 관련된 안내 메일을 재전송 합니다.
def sendEmail(CorpNum, MgtKeyType, MgtKey, ReceiverEmail, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 이메일 재전송할 세금계산서 문서번호 | |
ReceiverEmail | str | - | O | 수신자 이메일주소 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.6. SendSMS - 문자 재전송
- 세금계산서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
- 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
def sendSMS(CorpNum, MgtKeyType, MgtKey, Sender, Receiver, Contents, UserID=None):
- 함수 호출시 포인트가 과금됩니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
Sender | str | - | O | 발신번호 | |
Receiver | str | - | O | 수신번호 | |
Contents | str | 90 | O |
메시지 내용
※ 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송 |
|
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.7. SendFAX - 팩스 전송
- 세금계산서를 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
def sendFax(CorpNum, MgtKeyType, MgtKey, Sender, Receiver, UserID=None):
- 함수 호출시 포인트가 과금됩니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
Sender | str | - | O | 발신번호 | |
Receiver | str | - | O | 수신번호 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.8. AttachStatement - 전자명세서 첨부
- 팝빌 전자명세서 API를 통해 발행한 전자명세서를 세금계산서에 첨부합니다.
def attachStatement(CorpNum, MgtKeyType, MgtKey, ItemCode, StmtMgtKey, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
ItemCode | str | 3 | O |
첨부할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 ※ 전자명세서 발행시 입력한 값과 동일하게 작성 |
|
StmtMgtKey | str | 24 | O | 첨부할 전자명세서 문서번호 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.9. DetachStatement - 전자명세서 첨부해제
- 세금계산서에 첨부된 전자명세서를 해제합니다.
def detachStatement(CorpNum, MgtKeyType, MgtKey, ItemCode, StmtMgtKey, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
ItemCode | str | 3 | O |
첨부해제할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 ※ 전자명세서 발행시 입력한 값과 동일하게 작성 |
|
StmtMgtKey | str | 24 | O | 첨부해제할 전자명세서 문서번호 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.10. AssignMgtKey - 문서번호 할당
- 팝빌 사이트를 통해 발행하여 문서번호가 부여되지 않은 세금계산서에 문서번호를 할당합니다.
def assignMgtKey(CorpNum, MgtKeyType, ItemKey, MgtKey, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
MgtKeyType | str | - | O |
세금계산서 유형 : "SELL" / "BUY" / "TRUSTEE" 중 택 1
└ SELL : 매출 └ BUY : 매입, TRUSTEE = 위수탁 |
|
ItemKey | str | 18 | O |
팝빌에서 세금계산서 관리 목적으로 할당한 식별번호
└ 함수 [Search – 목록 조회]를 통하여 TaxinvoiceInfo의 'itemKey'를 확인 |
|
MgtKey | str | 24 | O | 파트너가 할당한 문서번호 | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.11. ListEmailConfig - 세금계산서 알림메일 발송설정 조회
- 세금계산서 관련 메일 항목에 대한 발송설정을 확인합니다.
def listEmailConfig(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.12. UpdateEmailConfig - 세금계산서 알림메일 발송설정 수정
- 세금계산서 관련 메일 항목에 대한 발송설정을 수정합니다.
def updateEmailConfig(Corpnum, EmailType, SendYN, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
EmailType | str | - | O |
발송 메일 유형
|
|
SendYN | bool | - | O |
메일 전송 여부 : True / False 중 택 1
└ True : 전송 └ False : 미전송 |
|
UserID | str | 50 | - | 팝빌회원 아이디 |
Return
Throws
4.13. GetSendToNTSConfig - 국세청 전송 옵션 설정 상태 확인
- 연동회원의 국세청 전송 옵션 설정 상태를 확인합니다. [참고] 팝빌 국세청 전송 정책
def getSendToNTSConfig(CorpNum):
- 국세청 전송 옵션 설정은 팝빌 사이트 [전자세금계산서] > [환경설정] > [세금계산서 관리] 메뉴에서 설정할 수 있으며, API로 설정은 불가능 합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
Return
bool - True : (발행 즉시 전송) / False : (익일 자동 전송)