부가기능

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

미리보기

전자세금계산서에 첨부될 인감, 사업자등록증, 통장사본을 등록하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 600px / height = 755px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

def getSealURL(corpNum, userID)

인감을 등록한 이후 세금계산서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 세금계산서가 발행됩니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userID	String	50	N	팝빌회원 아이디

응답

String - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

2. AttachFile - 파일 첨부

“임시저장” 상태의 세금계산서에 1개의 파일을 첨부합니다. (최대 5개)

def attachFile(corpNum, mgtKeyType, mgtKey, filePath, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	filePath	String	-	Y	첨부파일 경로
5	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

3. DeleteFile - 첨부파일 삭제

“임시저장” 상태의 세금계산서에 첨부된 1개의 파일을 삭제합니다.

• 파일 식별을 위해 첨부시 할당되는 ‘FileID’는 함수 [GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.

def deleteFile(corpNum, mgtKeyType, mgtKey, fileID, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	fileID	String	255	Y	팝빌이 할당한 파일 식별번호 → 함수 [GetFiles – 첨부파일 목록 확인]의 응답 객체 AttachedFile의 변수 'attachedFile'를 통해 확인 가능
5	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

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

세금계산서에 첨부된 파일목록을 확인합니다.

def getFiles(corpNum, mgtKeyType, mgtKey, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	userID	String	50	N	팝빌회원 아이디

응답

AttachedFile

순번	변수명	타입	길이	설명
1	serialNum	Integer	1	첨부파일 일련번호
2	attachedFile	String	255	팝빌이 할당한 파일 식별번호 → 팝빌이 첨부파일 관리를 위해 할당한 식별번호 함수 [DeleteFile – 첨부파일 삭제]호출을 위한 필수값
3	displayName	String	255	파일명
4	regDT	String	14	첨부일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

5. SendEmail - 메일 재전송

세금계산서와 관련된 안내 메일을 재전송 합니다.

def sendEmail(corpNum, mgtKeyType, mgtKey, receiverMail, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	메일 재전송할 세금계산서 문서번호
4	receiverMail	String	-	Y	수신자 메일주소
5	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

6. SendSMS - 문자 재전송

세금계산서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [ 문자 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.

• 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)

def sendSMS(corpNum, mgtKeyType, mgtKey, senderNum, receiverNum, contents, userID = '')

API 호출 시 포인트가 차감됩니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	senderNum	String	-	Y	발신번호
5	receiverNum	String	-	Y	수신번호
6	contents	String	90	Y	메시지 내용 → 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
7	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

7. SendFAX - 팩스 전송

세금계산서를 팩스로 전송하는 함수로, 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.

def sendFax(corpNum, mgtKeyType, mgtKey, senderNum, receiverNum, userID = '')

API 호출 시 포인트가 차감됩니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	senderNum	String	-	Y	발신번호
5	receiverNum	String	-	Y	수신번호
6	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

8. AttachStatement - 전자명세서 첨부

팝빌 전자명세서 API를 통해 발행한 전자명세서를 세금계산서에 첨부합니다.

def attachStatement(corpNum, mgtKeyType, mgtKey, itemCode, stmtMgtKey, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	itemCode	String	3	Y	첨부할 전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증 → 전자명세서 발행시 입력한 값과 동일하게 작성
5	stmtMgtKey	String	24	Y	첨부할 전자명세서 문서번호
6	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

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

세금계산서에 첨부된 전자명세서를 해제합니다.

def detachStatement(corpNum, mgtKeyType, mgtKey, itemCode, stmtMgtKey, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	mgtKey	String	24	Y	파트너가 할당한 문서번호
4	itemCode	String	3	Y	첨부해제할 전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증 → 전자명세서 발행시 입력한 값과 동일하게 작성
5	stmtMgtKey	String	24	Y	첨부해제할 전자명세서 문서번호
6	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

10. AssignMgtKey - 문서번호 할당

팝빌 사이트를 통해 발행하여 문서번호가 할당되지 않은 세금계산서에 문서번호를 할당합니다.

def assignMgtKey(corpNum, mgtKeyType, itemKey, mgtKey, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	mgtKeyType	MgtKeyType	-	Y	문서번호 유형 (택 1) SELL 매출 BUY 매입 TRUSTEE 위수탁
3	itemKey	String	18	Y	팝빌에서 할당한 식별번호 → 함수 [Search – 목록 조회]를 통하여 TaxinvoiceInfo의 'itemKey'를 확인
4	mgtKey	String	24	Y	파트너가 할당한 문서번호
5	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

11. ListEmailConfig - 알림메일 발송설정 조회

세금계산서 관련 메일 항목에 대한 발송설정을 확인합니다.

def listEmailConfig(corpNum, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userID	String	50	N	팝빌회원 아이디

응답

EmailSendConfig[ ]

순번	변수명	타입	길이	설명
1	emailType	String	-	메일 전송 유형 TAX_ISSUE_INVOICER (정발행) 공급자에게 세금계산서가 발행 되었음을 알려주는 메일 TAX_CHECK (정발행) 공급자에게 세금계산서가 수신확인 되었음을 알려주는 메일 TAX_CANCEL_ISSUE (정발행) 공급받는자에게 세금계산서가 발행취소 되었음을 알려주는 메일 TAX_REQUEST (역발행) 공급자에게 세금계산서를 전자서명 하여 발행을 요청하는 메일 TAX_CANCEL_REQUEST (역발행) 공급자에게 역발행 요청이 취소 되었음을 알려주는 메일 TAX_REFUSE (역발행) 공급받는자에게 세금계산서가 거부 되었음을 알려주는 메일 TAX_REVERSE_ISSUE (역발행) 공급받는자에게 전자세금계산서 발행 사실을 안내하는 메일 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 (정기발송) 팝빌에 등록된 인증서의 만료예정을 안내하는 메일
2	sendYN	Boolean	-	전송 여부 true 전송 false 미전송

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

12. UpdateEmailConfig - 알림메일 발송설정 수정

세금계산서 관련 메일 항목에 대한 발송설정을 수정합니다.

def updateEmailConfig(corpNum, emailType, sendYN, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	emailType	String	-	Y	메일 전송 유형 (택 1) TAX_ISSUE_INVOICER (정발행) 공급자에게 전자세금계산서 발행 사실을 안내하는 메일 TAX_CHECK (정발행) 공급자에게 전자세금계산서 수신확인 사실을 안내하는 메일 TAX_CANCEL_ISSUE (정발행) 공급받는자에게 전자세금계산서 발행취소 사실을 안내하는 메일 TAX_REQUEST (역발행) 공급자에게 전자세금계산서 발행을 요청하는 메일 TAX_CANCEL_REQUEST (역발행) 공급자에게 역발행 요청이 취소 되었음을 알려주는 메일 TAX_REFUSE (역발행) 공급받는자에게 전자세금계산서 거부 사실을 안내하는 메일 TAX_REVERSE_ISSUE (역발행) 공급받는자에게 전자세금계산서 발행 사실을 안내하는 메일 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 (정기발송) 팝빌에 등록된 인증서의 만료예정을 안내하는 메일
3	sendYN	Boolean	-	Y	메일 전송 여부 true 전송 false 미전송
4	userID	String	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지

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

연동회원의 국세청 전송 옵션 설정 상태를 확인합니다. [참고] 팝빌 국세청 전송 정책

def getSendToNTSConfig(corpNum, userID = '')

국세청 전송 옵션 설정은 팝빌 사이트 (https://www.popbill.com) 로그인 > 전자세금계산서 > 관리 > 환경설정 메뉴에서 설정할 수 있으며, API로 설정은 불가능 합니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userID	String	50	N	팝빌회원 아이디

응답

Boolean - true : (발행 즉시 전송) / false : (익일 자동 전송)

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	String	-	API 처리 실패에 대한 오류메시지