부가기능

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

미리보기

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

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

def getSealURL(CorpNum, UserID)

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

요청

Parameters

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

응답

str - 요청에 대한 응답 URL

예외

PopbillException

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

2. AttachFile - 파일 첨부

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

def attachFile(CorpNum, ItemCode, MgtKey, FilePath, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	FilePath	str	-	Y	첨부파일 경로
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

3. AttachFileBinary - 파일 첨부 (바이너리)

“임시저장” 상태의 명세서에 1개의 파일(바이너리)을 첨부합니다. (최대 5개)

def attachFileBinary(CorpNum, ItemCode, MgtKey, BinaryFile, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	BinaryFile	BinaryFile	-	Y	첨부 파일
BinaryFile 순번 변수명 타입 길이 필수 설명 1 fileName str 255 Y 파일명 2 fileData bytes - Y 파일의 바이너리 데이터
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

4. DeleteFile - 첨부파일 삭제

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

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

def deleteFile(CorpNum, ItemCode, MgtKey, FileID, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	FileID	str	255	Y	팝빌이 할당한 파일 식별번호 → 함수 [GetFiles – 첨부파일 목록 확인]의 리턴값 중 'attachedFile' 필드 참조
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

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

전자명세서에 첨부된 파일목록을 확인합니다.

def getFiles(CorpNum, ItemCode, MgtKey)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호

응답

list[AttachedFile]

순번	변수명	타입	길이	설명
1	serialNum	int	1	첨부파일 일련번호
2	attachedFile	str	255	팝빌이 할당한 파일 식별번호
3	displayName	str	255	파일명
4	regDT	str	14	첨부일시 → 형식 : yyyyMMddHHmmss

예외

PopbillException

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

6. SendEmail - 메일 재전송

“승인대기”, “발행완료” 상태의 전자명세서와 관련된 발행 안내 메일을 재전송 합니다.

def sendEmail(CorpNum, ItemCode, MgtKey, ReceiverEmail, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	메일 재전송할 전자명세서 문서번호
4	ReceiverEmail	str	-	Y	수신자 메일주소
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

7. SendSMS - 문자 재전송

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

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

def sendSMS(CorpNum, ItemCode, MgtKey, Sender, Receiver, Contents, UserID=None)

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

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	Sender	str	-	Y	발신번호
5	Receiver	str	-	Y	수신번호
6	Contents	str	90	Y	메시지 내용 → 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
7	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

8. SendFAX - 팩스 전송

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

def sendFAX(CorpNum, ItemCode, MgtKey, Sender, Receiver, UserID=None)

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

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	Sender	str	-	Y	발신번호
5	Receiver	str	-	Y	수신번호
6	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

9. FAXSend - 선팩스 전송

전자명세서를 팩스로 전송하는 함수로, 팝빌에 데이터를 저장하는 과정이 없습니다.

• 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.

def FAXSend(CorpNum, statement, SendNum, ReceiveNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	statement	Statement	-	Y	전자명세서 정보
Statement 순번 변수명 타입 길이 필수 설명 1 itemCode int 3 Y 전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증 2 mgtKey str 24 Y 문서번호 → 전자명세서 관리를 위해 파트너가 할당하는 식별번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 3 formCode str 8 N 맞춤양식 코드 ※ 기본값 : 팝빌에서 설정한 기본양식 사용 4 writeDate str 8 Y 작성일자 → 형식 : yyyyMMdd 5 taxType str 2 조건부 과세형태 (택 1) 과세 영세 면세 ✓ {itemCode}=121 경우 필수 6 purposeType str - Y 영수/청구 (택 1) 영수 청구 없음 7 serialNum str 30 N 일련번호 8 taxTotal str 18 Y 세액 합계 → 정수만 입력 가능 마이너스 금액 입력 가능, 소수점 아래 자동 절사 9 supplyCostTotal str 18 Y 공급가액 합계 → 정수만 입력 가능 마이너스 금액 입력 가능, 소수점 아래 자동 절사 10 totalAmount str 18 N 합계금액 → 정수만 입력 가능 마이너스 금액 입력 가능, 소수점 아래 자동 절사 11 remark1 str 150 N 비고 1 12 remark2 str 150 N 비고 2 13 remark3 str 150 N 비고 3 14 senderCorpNum str 10 Y 발신자 사업자번호 ('-' 제외) 15 senderTaxRegID str 4 N 발신자 종사업장 식별번호 → 종사업장 식별번호는 4자리 숫자로만 구성 16 senderCorpName str 200 N 발신자 상호 17 senderCEOName str 100 N 발신자 대표자성명 18 senderAddr str 300 N 발신자 주소 19 senderBizType str 100 N 발신자 업태 20 senderBizClass str 100 N 발신자 종목 21 senderContactName str 100 N 발신자 성명 22 senderDeptName str 40 N 발신자 부서명 23 senderTEL str 20 N 발신자 연락처 24 senderHP str 20 N 발신자 휴대전화 25 senderEmail str 100 N 발신자 메일주소 26 senderFAX str 20 N 발신자 팩스번호 27 receiverCorpNum str 10 N 수신자 사업자번호 ('-' 제외) 28 receiverTaxRegID str 4 N 수신자 종사업장 식별번호 → 종사업장 식별번호는 4자리 숫자로만 구성 29 receiverCorpName str 200 Y 수신자 상호 30 receiverCEOName str 100 N 수신자 대표자성명 31 receiverAddr str 300 N 수신자 주소 32 receiverBizType str 100 N 수신자 업태 33 receiverBizClass str 100 N 수신자 종목 34 receiverContactName str 100 N 수신자 성명 35 receiverDeptName str 40 N 수신자 부서명 36 receiverTEL str 20 N 수신자 연락처 37 receiverHP str 20 N 수신자 휴대전화 38 receiverEmail str 100 N 수신자 메일주소 39 receiverFAX str 20 N 수신자 팩스번호 40 businessLicenseYN bool - N 팝빌에 등록된 사업자등록증 첨부 여부 True 첨부 False 미첨부 : 기본값 → 팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록 41 bankBookYN bool - N 팝빌에 등록된 통장사본 첨부 여부 True 첨부 False 미첨부 : 기본값 → 팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록 42 smssendYN bool - N 알림문자 전송 여부 True 전송 False 미전송 : 기본값 → 수신자 : 수신자 휴대폰번호 {receiverHP} 문자 전송 포인트가 차감(단, 전송실패 건은 환불) 43 propertyBag dict - N 추가속성 → 전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력 [참고] 기본양식 추가속성 44 detailList StatementDetail[] - N 거래 물품 상세정보 → 길이 제한 없음 StatementDetail[] 순번 변수명 타입 길이 필수 설명 1 serialNum int - Y 일련번호 → 1부터 순차적으로 입력 2 purchaseDT str 8 N 거래일자 → 형식 : yyyyMMdd 3 itemName str 100 N 품명 4 spec str 60 N 규격 5 qty str 12 N 수량 → 소수점 아래 2번째 자리까지 입력 가능 6 unitCost str 18 N 단가 → 소수점 아래 2번째 자리까지 입력 가능 마이너스 금액 입력 가능 7 supplyCost str 18 N 공급가액 → 정수만 입력 가능 마이너스 금액 입력 가능, 소수점 아래 자동 절사 8 tax str 18 N 세액 → 정수만 입력 가능 마이너스 금액 입력 가능, 소수점 아래 자동 절사 9 remark str 100 N 비고 10 spare1 str 100 N 여분1 11 spare2 str 100 N 여분2 12 spare3 str 100 N 여분3 13 spare4 str 100 N 여분4 14 spare5 str 100 N 여분5 15 spare6 str 100 N 여분6 16 spare7 str 100 N 여분7 17 spare8 str 100 N 여분8 18 spare9 str 100 N 여분9 19 spare10 str 100 N 여분10 20 spare11 str 100 N 여분11 21 spare12 str 100 N 여분12 22 spare13 str 100 N 여분13 23 spare14 str 100 N 여분14 24 spare15 str 100 N 여분15 25 spare16 str 100 N 여분16 26 spare17 str 100 N 여분17 27 spare18 str 100 N 여분18 28 spare19 str 100 N 여분19 29 spare20 str 100 N 여분20
3	SendNum	str	-	Y	발신번호 → 팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
4	ReceiveNum	str	-	Y	수신번호
5	UserID	str	50	N	팝빌회원 아이디

응답

str - 요청에 대한 접수번호(receiptNum)

예외

PopbillException

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

10. AttachStatement - 전자명세서 첨부

하나의 전자명세서에 다른 전자명세서를 첨부합니다.

def attachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	SubItemCode	int	3	Y	첨부할 전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
5	SubMgtKey	str	24	Y	첨부할 전자명세서 문서번호
6	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

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

하나의 전자명세서에 첨부된 다른 전자명세서를 해제합니다.

def detachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ItemCode	int	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	SubItemCode	int	3	Y	첨부해제할 전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
5	SubMgtKey	str	24	Y	첨부해제할 전자명세서 문서번호
6	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

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

전자명세서 관련 메일 항목에 대한 발송설정을 확인합니다.

def listEmailConfig(CorpNum, UserID=None)

요청

Parameters

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

응답

list[EmailSendConfig]

순번	변수명	타입	길이	설명
1	emailType	str	-	메일 전송 유형 SMT_ISSUE 수신자에게 전자명세서가 발행 되었음을 알려주는 메일 SMT_ACCEPT 발신자에게 전자명세서가 승인 되었음을 알려주는 메일 SMT_DENY 발신자에게 전자명세서가 거부 되었음을 알려주는 메일 SMT_CANCEL 수신자에게 전자명세서가 취소 되었음을 알려주는 메일 SMT_CANCEL_ISSUE 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
2	sendYN	bool	-	메일 전송 여부 True 전송 False 미전송

예외

PopbillException

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

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

전자명세서 관련 메일 항목에 대한 발송설정을 수정합니다.

def updateEmailConfig(Corpnum, EmailType, SendYN, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	Corpnum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	EmailType	str	-	Y	메일 전송 유형 SMT_ISSUE 수신자에게 전자명세서가 발행 되었음을 알려주는 메일 SMT_ACCEPT 발신자에게 전자명세서가 승인 되었음을 알려주는 메일 SMT_DENY 발신자에게 전자명세서가 거부 되었음을 알려주는 메일 SMT_CANCEL 수신자에게 전자명세서가 취소 되었음을 알려주는 메일 SMT_CANCEL_ISSUE 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
3	SendYN	bool	-	Y	전송 여부
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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