부가기능
1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL
섹션 제목: “1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL”
전자세금계산서에 첨부될 인감, 사업자등록증, 통장사본을 등록하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 600px / height = 755px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
String getSealURL(String CorpNum, String UserID) throws PopbillException인감을 등록한 이후 세금계산서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 세금계산서가 발행됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | String | 50 | N | 팝빌회원 아이디 |
String - 요청에 대한 응답 URL
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
2. AttachFile - 파일 첨부
섹션 제목: “2. AttachFile - 파일 첨부”- “임시저장” 상태의 세금계산서에 1개의 파일을 첨부합니다. (최대 5개)
Response attachFile(String CorpNum, MgtKeyType KeyType, String MgtKey, String DisplayName, InputStream FileData, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | DisplayName | String | 255 | Y | 파일명 |
| 5 | FileData | InputStream | - | Y | 파일 데이터 |
| 6 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
3. DeleteFile - 첨부파일 삭제
섹션 제목: “3. DeleteFile - 첨부파일 삭제”- “임시저장” 상태의 세금계산서에 첨부된 1개의 파일을 삭제합니다.
- 파일 식별을 위해 첨부시 할당되는 ‘FileID’는 함수 [GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
Response deleteFile(String CorpNum, MgtKeyType KeyType, String MgtKey, String FileID, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | FileID | String | 255 | Y | 팝빌이 할당한 파일 식별번호 함수 [GetFiles – 첨부파일 목록 확인]의 응답 객체 AttachedFile의 변수 'attachedFile'를 통해 확인 가능 |
| 5 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
4. GetFiles - 첨부파일 목록 확인
섹션 제목: “4. GetFiles - 첨부파일 목록 확인”- 세금계산서에 첨부된 파일목록을 확인합니다.
AttachedFile[] getFiles(String CorpNum, MgtKeyType KeyType, String MgtKey, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | UserID | String | 50 | N | 팝빌회원 아이디 |
AttachedFile[ ]
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | serialNum | Integer | 1 | 첨부파일 일련번호 |
| 2 | attachedFile | String | 255 | |
| 3 | displayName | String | 255 | 파일명 |
| 4 | regDT | String | 14 | 첨부일시 형식 : yyyyMMddHHmmss |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
5. SendEmail - 메일 재전송
섹션 제목: “5. SendEmail - 메일 재전송”- 세금계산서와 관련된 안내 메일을 재전송 합니다.
Response sendEmail(String CorpNum, MgtKeyType KeyType, String MgtKey, String Receiver, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | Receiver | String | - | Y | 수신자 메일주소 |
| 5 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
6. SendSMS - 문자 재전송
섹션 제목: “6. SendSMS - 문자 재전송”- 세금계산서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [ 문자 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.
- 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
Response sendSMS(String CorpNum, MgtKeyType KeyType, String MgtKey, String Sender, String Receiver, String Contents, String UserID) throws PopbillExceptionAPI 호출 시 포인트가 차감됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | Sender | String | - | Y | 발신번호 |
| 5 | Receiver | String | - | Y | 수신번호 |
| 6 | Contents | String | 90 | Y | 메시지 내용 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송 |
| 7 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
7. SendFAX - 팩스 전송
섹션 제목: “7. SendFAX - 팩스 전송”- 세금계산서를 팩스로 전송하는 함수로, 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.
Response sendFAX(String CorpNum, MgtKeyType KeyType, String MgtKey, String Sender, String Receiver, String UserID) throws PopbillExceptionAPI 호출 시 포인트가 차감됩니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | Sender | String | - | Y | 발신번호 |
| 5 | Receiver | String | - | Y | 수신번호 |
| 6 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
8. AttachStatement - 전자명세서 첨부
섹션 제목: “8. AttachStatement - 전자명세서 첨부”- 팝빌 전자명세서 API를 통해 발행한 전자명세서를 세금계산서에 첨부합니다.
Response attachStatement(String CorpNum, MgtKeyType KeyType, String MgtKey, int SubItemCode, String SubMgtKey, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | SubItemCode | int | 3 | Y | 첨부할 전자명세서 문서 유형 (택 1)
전자명세서 발행시 입력한 값과 동일하게 작성 |
| 5 | SubMgtKey | String | 24 | Y | 첨부할 전자명세서 문서번호 |
| 6 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
9. DetachStatement - 전자명세서 첨부해제
섹션 제목: “9. DetachStatement - 전자명세서 첨부해제”- 세금계산서에 첨부된 전자명세서를 해제합니다.
Response detachStatement(String CorpNum, MgtKeyType KeyType, String MgtKey, int SubItemCode, String SubMgtKey, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 4 | SubItemCode | int | 3 | Y | 첨부해제할 전자명세서 문서 유형 (택 1)
전자명세서 발행시 입력한 값과 동일하게 작성 |
| 5 | SubMgtKey | String | 24 | Y | 첨부해제할 전자명세서 문서번호 |
| 6 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
10. AssignMgtKey - 문서번호 할당
섹션 제목: “10. AssignMgtKey - 문서번호 할당”- 팝빌 사이트를 통해 발행하여 문서번호가 할당되지 않은 세금계산서에 문서번호를 할당합니다.
Response assignMgtKey(String CorpNum, MgtKeyType KeyType, String ItemKey, String MgtKey, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | KeyType | MgtKeyType | - | Y | 문서번호 유형 (택 1)
|
| 3 | ItemKey | String | 18 | Y | 팝빌에서 할당한 식별번호 함수 [Search – 목록 조회]를 통하여 TaxinvoiceInfo의 'itemKey'를 확인 |
| 4 | MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
| 5 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
11. ListEmailConfig - 알림메일 발송설정 조회
섹션 제목: “11. ListEmailConfig - 알림메일 발송설정 조회”- 세금계산서 관련 메일 항목에 대한 발송설정을 확인합니다.
EmailSendConfig[] listEmailConfig(String CorpNum, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | String | 50 | N | 팝빌회원 아이디 |
EmailSendConfig[ ]
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | emailType | String | - | 메일 전송 유형
|
| 2 | sendYN | Boolean | - | 전송 여부
|
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
12. UpdateEmailConfig - 알림메일 발송설정 수정
섹션 제목: “12. UpdateEmailConfig - 알림메일 발송설정 수정”- 세금계산서 관련 메일 항목에 대한 발송설정을 수정합니다.
Response updateEmailConfig(String CorpNum, String EmailType, Boolean SendYN, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | EmailType | String | - | Y | 메일 전송 유형 (택 1)
|
| 3 | SendYN | Boolean | - | Y | 메일 전송 여부
|
| 4 | UserID | String | 50 | N | 팝빌회원 아이디 |
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
13. GetSendToNTSConfig - 국세청 전송 옵션 설정 상태 확인
섹션 제목: “13. GetSendToNTSConfig - 국세청 전송 옵션 설정 상태 확인”- 연동회원의 국세청 전송 옵션 설정 상태를 확인합니다. [참고] 팝빌 국세청 전송 정책
Boolean getSendToNTSConfig(String CorpNum, String UserID) throws PopbillException국세청 전송 옵션 설정은 팝빌 사이트 (https://www.popbill.com) 로그인 > 전자세금계산서 > 관리 > 환경설정 메뉴에서 설정할 수 있으며, API로 설정은 불가능 합니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | String | 50 | N | 팝빌회원 아이디 |
Boolean - true : (발행 즉시 전송) / false : (익일 자동 전송)
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |