Index

1. 전자명세서 발행

1.1. CheckMgtKeyInUse - 문서번호 사용여부 확인

ㆍ 전자명세서의 문서번호의 사용여부를 확인합니다.

ㆍ 문서번호란 전자명세서 발행시 중복방지/문서식별을 위해 파트너가 할당하는 기본키(Primary Key) 역할을 하는 필드입니다.

ㆍ 사용중인 문서번호는 새로운 전자명세서 발행시 부여할 수 없습니다.

Function CheckMgtKeyInUse(CorpNum, itemCode, mgtKey)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호

Return

boolean - True(사용중) / False(미사용중)

Throws

Err

1.2. RegistIssue - 즉시 발행

ㆍ 전자명세서를 즉시 발행 처리합니다.

ㆍ 함수 호출 시 포인트가 차감되며, Statement 객체 클래스의 멤버 변수로 작성된 수신자 메일주소(receiverEmail)로 발행 안내 메일이 전송됩니다.

Function RegistIssue(CorpNum, ByRef statement, Memo, UserID, EmailSubject)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 statement Statement - O 전자명세서 객체정보
3 Memo String 200 - 메모
4 UserID String 50 - 팝빌회원 아이디
5 EmailSubject String 300 - 전자명세서 발행시 공급받는자에게 발송되는 메일 제목, 미기재 시 팝빌에서 지정한 이메일 제목으로 전송

Return

Response

Throws

Err

1.3. Register - 임시저장

ㆍ 전자명세서를 임시저장 처리합니다. '임시저장' 상태의 전자명세서는 수신자에게 안내 메일이 전송되지 않으며, 반드시 발행(Issue API) 함수를 호출해야 메일이 전송됩니다.

ㆍ 임시저장(Register API) 과 발행(Issue API) 처리를 한 번의 함수 호출로 처리하는 즉시 발행(RegistIssue API) 함수 사용을 권장합니다.

Function Register(CorpNum, ByRef statement, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 statement Statement - O 전자명세서 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

1.4. Update - 수정

ㆍ 전자명세서를 수정 처리합니다. '임시저장' 상태에서만 수정이 가능합니다.

Function Update(CorpNum, itemCode, mgtKey, ByRef statement, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 statement Statement - O 전자명세서 객체정보
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

1.5. Issue - 발행

'임시저장' 상태의 전자명세서를 발행 처리합니다.

ㆍ 발행 함수 호출 시 포인트가 차감되며, 전자명세서 기재 항목 중 수신자 메일주소(receiverEmail)에 작성된 메일 주소로 발행 안내 메일이 전송됩니다.

Function Issue(CorpNum, itemCode, mgtKey, Memo, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 Memo String 200 - 메모, 상태확인(GetInfo API) stateMemo(상태메모) 확인 가능
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

1.6. CancelIssue - 발행취소

ㆍ 발신자가 발행한 전자명세서를 발행취소합니다.

'발행취소' 상태의 전자명세서를 삭제 (Delete API) 처리하면, 전자명세서 관리를 위해 부여했던 문서번호를 재사용 할 수 있습니다.

Function CancelIssue(CorpNum, itemCode, mgtKey, Memo, UserID)

문서번호를 재사용 하기 위해서는 삭제(Delete API) 호출하여 해당 전자명세서를 삭제해야 합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 Memo String 200 - 메모, 상태확인(GetInfo API) stateMemo(상태메모) 확인 가능
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

1.7. Delete - 삭제

ㆍ 삭제 가능한 상태의 전자명세서를 삭제 처리합니다. 삭제처리된 전자명세서에 사용된 문서번호는 재사용 할 수 있습니다.

Function Delete(CorpNum, itemCode, mgtKey, UserID)

삭제가능 상태 : 임시저장, 취소, 승인거부, 발행취소

Parameters

순번 변수명 타입 길이 필수 예제
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

2. 전자명세서 정보확인

2.1. GetInfo - 상태 확인

ㆍ 전자명세서의 1건의 상태 및 요약정보 확인합니다.

ㆍ 반환되는 항목에 대한 정보는 리턴타입 StatementInfo Class 참조 StatementInfo

Function GetInfo(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

StatementInfo

Throws

Err

2.2. GetInfos - 상태 대량 확인

ㆍ 다수건의 전자명세서 상태 및 요약정보 확인합니다. (최대 1,000건)

ㆍ 전자명세서 목록을 구현하는 경우 GetInfos 함수 활용을 권장합니다.

ㆍ StatementInfo Class Object가 배열로 반환되며 Class 항목에 대한 정보는 리턴타입 StatementInfo Class 참조 StatementInfo

Function GetInfos(CorpNum, itemCode, mgtKeyList, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKeyList Arrays 1000 O 문서번호 배열 (최대 1,000건)
4 UserID String 50 - 팝빌회원 아이디

Return

StatementInfo[]

Throws

Err

2.3. GetDetailInfo - 상세정보 확인

ㆍ 전자명세서 1건의 상세정보 확인합니다.

ㆍ 전자명세서 품목 리스트 및 발신자/수신자 정보를 출력하는 화면 구현시 GetDetailInfo 함수 활용을 권장합니다.

ㆍ 반환되는 리턴타입에 대한 자세한 정보는 Statement Class 참조 Statement

Function GetDetailInfo(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

Statement

Throws

Err

2.4. Search - 목록 조회

ㆍ 검색조건에 해당하는 전자명세서 목록을 조회합니다.

ㆍ 페이지 관련 항목(Page, PerPage, Order)을 활용하여 전자명세서 목록 페이지 기능을 구현할 수 있습니다.

Function Search(CorpNum, DType, SDate, EDate, State, ItemCode, Order, Page, PerPage, QString)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 DType String 1 O 일자유형 [ R-등록일자, W-작성일자, I-발행일자 중 택1 ]
3 SDate String 8 O 시작일자, 날짜형식(yyyyMMdd)
4 EDate String 8 O 종료일자, 날짜형식(yyyyMMdd)
5 State Arrays - O [배열] 상태코드, 상태코드 2,3번째 자리에 와일드카드(*) 사용가능, 예) "1**", "3**"
[부록] "전자명세서 상태코드"
6 ItemCode Arrays - O [배열] 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
7 Order String 1 O 정렬 방향, 기본값 'D' [ D-내림차순, A-오름차순 중 택1 ]
8 Page Integer - O 페이지번호, 기본값 '1'
9 PerPage Integer - O 페이지당 검색개수, 기본값 500, 최대 1000
10 QString String - O 거래처 상호 또는 사업자번호 검색 조회, 공백처리시 전체조회

Return

StmtSearchResult

Throws

Err

2.5. GetLogs - 상태 변경이력 확인

ㆍ 전자명세서의 상태 변경이력을 확인합니다.

ㆍ 전자명세서 상태, 요청일시, 요청 IP, 처리담당자 등의 정보를 이력정보 배열을 통해 확인 할 수 있습니다.

Function GetLogs(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

StatementLog[]

Throws

Err

2.6. GetURL - 전자명세서 문서함 관련 URL

ㆍ 팝빌 사이트의 전자명세서 문서함 메뉴에 로그인 된 상태로 접근할 수 있는 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetURL(CorpNum, UserID, TOGO)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디
3 TOGO String - O TBOX-임시문서함 / SBOX-매출문서함 / PBOX-매입문서함 / WRITE-매출작성 중 택1

Return

String - 요청에 대한 응답 URL

Throws

Err

3. 전자명세서 보기/인쇄

3.1. GetPopUpURL - 전자명세서 보기 URL

ㆍ 팝빌 사이트의 전자명세서 1건의 보기 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetPopUpURL(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.2. GetPrintURL - 전자명세서 인쇄 URL [발신자/수신자 용]

ㆍ 전자명세서 1건의 인쇄 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetPrintURL(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.3. GetEPrintURL - 전자명세서 인쇄 URL [수신자용]

ㆍ 전자명세서 1건의 수신자용 인쇄 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetEPrintURL(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.4. GetMassPrintURL - 전자명세서 대량 인쇄 URL

ㆍ 전자명세서를 최대 100건 출력할 수 있는 인쇄 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetMassPrintURL(CorpNum, itemCode, mgtKeyList, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKeyList Arrays 100 O 문서번호 배열 (최대 100건)
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

3.5. GetMailURL - 전자명세서 메일링크 URL

ㆍ 수신자가 수신하는 안내 메일의 하단 버튼 링크 URL 주소를 반환합니다.

ㆍ 전자명세서 메일 링크 URL 함수를 통해 반환된 URL은 제한시간을 갖지 않습니다.

Function GetMailURL(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

Err

4. 부가기능

4.1. GetAccessURL - 팝빌 로그인 URL

ㆍ 팝빌 사이트에 로그인 상태로 접근할 수 있는 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetAccessURL(CorpNum, UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

4.2. AttachFile - 첨부파일 추가

ㆍ 전자명세서에 첨부파일을 추가합니다. (최대 5개 파일 추가 가능)

ㆍ 전자명세서 첨부파일 추가는 '임시저장' 상태만 가능 합니다.

Function AttachFile(CorpNum, itemCode, mgtKey, filePath, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 filePath String - O 첨부파일 경로
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

4.3. DeleteFile - 첨부파일 삭제

ㆍ 전자명세서에 첨부된 파일을 삭제합니다.

ㆍ 첨부된 파일을 식별하는 FileID는 첨부파일 목록 확인 (GetFiles API) 함수의 반환 항목을 통해 확인합니다.

Function DeleteFile(CorpNum, itemCode, mgtKey, FileID, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 FileID String 255 O 파일아이디, GetFiles API 반환값 중 attachedFile 필드 참조
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

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

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

Function GetFiles(CorpNum, itemCode, mgtKey, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

AttachedFile[]

Throws

Err

4.5. SendEmail - 메일 전송

ㆍ 전자명세서 안내 메일을 재전송 합니다.

Function SendEmail(CorpNum, itemCode, mgtKey, receiver, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 receiver String - O 수신자 이메일주소
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

4.6. SendSMS - 문자 전송

ㆍ SMS(단문) 문자를 전송합니다.

ㆍ 메시지 길이가 90byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 삭제되어 전송됩니다. (한글 최대 45자)

ㆍ 문자 전송시 포인트가 차감됩니다. (전송실패시 환불처리)

ㆍ 팝빌 사이트의 [문자 팩스] > [문자] > [전송내역] 페이지에서 전송결과 확인

Function SendSMS(CorpNum, itemCode, mgtKey, sender, receiver, contents, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 sender String - O 발신번호
5 receiver String - O 수신번호
6 contents String 90 O 문자메시지 내용, 최대 90Byte 초과된 내용은 삭제되어 전송됨
7 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

4.7. SendFAX - 팩스 전송

ㆍ 전자명세서를 팩스 전송합니다.

ㆍ 팩스 전송시 포인트가 차감됩니다. (전송실패시 환불처리)

ㆍ 팝빌 사이트 > [문자 팩스] > [팩스] > [전송내역] 메뉴에서 전송결과 확인

Function SendFAX(CorpNum, itemCode, mgtKey, sender, receiver, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 mgtKey String 24 O 파트너가 부여한 문서번호
4 sender String - O 발신번호
5 receiver String - O 수신번호
6 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

4.8. FAXSend - 선팩스 전송

ㆍ 팝빌에 전자명세서를 등록하지 않고 팩스 전송합니다.

ㆍ 팝빌 사이트 > [문자 팩스] > [팩스] > [전송내역] 메뉴에서 전송결과 확인

Function FAXSend(CorpNum, ByRef statement, SendNum, ReceiveNum, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 statement Statement - O 전자명세서 객체정보
3 SendNum String - O 발신번호
4 ReceiveNum String - O 수신번호
5 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

4.9. AttachStatement - 전자명세서 첨부

ㆍ 전자명세서에 다른 전자명세서를 첨부합니다.

Function AttachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ItemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 MgtKey String 24 O 파트너가 부여한 문서번호
4 SubItemCode Integer 3 O 첨부할 전자명세서 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
5 SubMgtKey String 24 O 첨부할 전자명세서 문서번호

Return

Response

Throws

Err

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

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

Function DetachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Itemcode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 MgtKey String 24 O 파트너가 부여한 문서번호
4 SubItemCode Integer 3 O 첨부해제할 전자명세서 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
5 SubMgtKey String 24 O 첨부해제할 전자명세서 문서번호

Return

Response

Throws

Err

4.11. ListEmailConfig - 전자명세서 알림메일 전송목록 조회

ㆍ 전자명세서 관련 메일전송 항목에 대한 전송여부를 목록을 반환합니다.

Function listEmailConfig(CorpNum, UserID)

Parameters

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

Return

EmailSendConfig[]

Throws

Err

4.12. UpdateEmailConfig - 전자명세서 알림메일 전송설정 수정

ㆍ 전자명세서 관련 메일전송 항목에 대한 전송여부를 수정합니다.

Function updateEmailConfig(CorpNum, mailType, sendYN, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mailType String - O 메일 전송 유형

SMT_ISSUE : 수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT : 발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY : 발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL : 수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE : 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일

3 sendYN boolean - O 전송 여부
4 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

5. 포인트 관리

5.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ 연동회원 잔여포인트를 확인합니다.

Function GetBalance(CorpNum)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

String - 연동회원 잔여포인트

Throws

Err

5.2. GetChargeURL - 연동회원 포인트충전 URL

ㆍ 팝빌 연동회원 사업자의 포인트 충전 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetChargeURL(CorpNum, UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

5.3. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ 파트너 잔여포인트를 확인합니다.

Function GetPartnerBalance(CorpNum)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

String - 파트너 잔여포인트

Throws

Err

5.4. GetPartnerURL - 파트너 포인트충전 URL

ㆍ 파트너 포인트충전 팝업 URL 을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

Function GetPartnerURL(CorpNum, TOGO)

반환된 URL의 제한 시간은 30초이며, 제한 시간 이후에는 정상적으로 표시되지 않습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO String - O CHRG : 파트너 포인트 충전

Return

String - 요청에 대한 응답 URL

Throws

Err

5.5. GetUnitCost - 발행 단가 확인

ㆍ 전자명세서 발행시 과금되는 포인트 단가를 확인합니다.

Function GetUnitCost(CorpNum, itemCode)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 itemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증

Return

String - 전자명세서 발행단가

Throws

Err

5.6. GetChargeInfo - 과금정보 확인

ㆍ 전자명세서 서비스 과금정보를 확인합니다.

Function GetChargeInfo(CorpNum, ItemCode, UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ItemCode Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
3 UserID String 50 - 팝빌회원 아이디

Return

ChargeInfo

Throws

Err

6. 회원정보

6.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ 사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

Function CheckIsMember(CorpNum, linkID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 linkID String - O 링크아이디

Return

Response

Throws

Err

6.2. CheckID - 아이디 중복 확인

ㆍ 팝빌회원 아이디 중복여부를 확인합니다.

Function CheckID(id)

Parameters

순번 변수명 타입 길이 필수 설명
1 id String 10 O 중복여부 확인 할 아이디

Return

Response

Throws

Err

6.3. JoinMember - 연동회원 신규가입

ㆍ 사업자의 연동회원 가입처리를 요청합니다.

Function JoinMember(JoinInfo)

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo JoinForm - O 연동 회원 정보 객체

Return

Response

Throws

Err

6.4. GetCorpInfo - 회사정보 확인

ㆍ 팝빌 연동회원의 회사정보를 확인합니다.

Function GetCorpInfo(CorpNum, UserId)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserId String 50 - 팝빌회원 아이디

Return

CorpInfo

Throws

Err

6.5. UpdateCorpInfo - 회사정보 수정

ㆍ 팝빌 연동회원의 회사정보를 수정합니다.

Function UpdateCorpInfo(CorpNum, corpInfo, UserId)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 corpInfo CorpInfo - O 회사정보 객체
3 UserId String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

6.6. RegistContact - 담당자 등록

ㆍ 팝빌 연동회원 사업자의 담당자 정보(팝빌 로그인 계정)를 추가합니다.

ㆍ 하나의 사업자번호에 다수의 담당자 정보(팝빌 로그인 계정)를 추가할 수 있습니다.

Function RegistContact(CorpNum, contInfo, UserId)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 contInfo ContactInfo - O 담당자 정보 객체
3 UserId String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

6.7. ListContact - 담당자 목록 확인

ㆍ 팝빌 연동회원 사업자의 담당자 목록을 확인합니다.

Function ListContact(CorpNum, UserID)

Parameters

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

Return

ContactInfo[]

Throws

Err

6.8. UpdateContact - 담당자 정보 수정

ㆍ 팝빌 연동회원 사업자의 담당자 정보를 수정합니다.

Function UpdateContact(CorpNum, contInfo, UserId)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 contInfo ContactInfo - O 담당자 정보 객체
3 UserId String 50 - 팝빌회원 아이디

Return

Response

Throws

Err

A. 객체정보

A.1. Response

순번 변수명 항목명 타입 길이 비고
1 code 코드 Integer O API 처리에 대한 응답 상태코드
2 message 메시지 String O API 처리에 대한 응답 메시지

A.2. Err

순번 변수명 항목명 타입 길이 비고
1 Number 코드 Long - API 처리 실패에 대한 오류코드(-로 시작하는 8자리 숫자값)
2 Description 메시지 String - API 처리 실패에 대한 오류메시지

A.3. Statement

순번 변수명 항목명 타입 길이 필수 비고
1 itemCode 문서종류코드 Integer 3 O 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
2 mgtKey 문서번호 String 24 - 파트너가 부여하는 고유번호
3 invoiceNum 팝빌승인번호 String 24 - 미기재, 팝빌에서 자동으로 부여
4 formCode 맞춤양식 코드 String 8 - 미기재시 기본양식으로 처리
5 writeDate 작성일자 String 8 O 날짜형식(yyyyMMdd)
6 taxType 과세형태 String 4 O "과세", "영세", "면세" 중 기재
7 purposeType 영수/청구 String - O "영수", "청구" 중 기재
8 serialNum 일련번호 String 30 - 기재 상 "일련번호" 항목
9 taxTotal 세액 합계 String 18 O 숫자만 가능
10 supplyCostTotal 공급가액 합계 String 18 O 숫자만 가능
11 totalAmount 합계금액 String 18 - 숫자만 가능
12 remark1 비고 1 String 150 -
13 remark2 비고 2 String 150 -
14 remark3 비고 3 String 150 -
15 senderCorpNum 발신자 사업자번호 String 10 O
16 senderTaxRegID 발신자 종사업장번호 String 4 - 숫자 4자리 기재
17 senderCorpName 발신자 상호 String 200 -
18 senderCEOName 발신자 대표자성명 String 100 -
19 senderAddr 발신자 주소 String 300 -
20 senderBizType 발신자 업태 String 100 -
21 senderBizClass 발신자 종목 String 100 -
22 senderContactName 발신자 성명 String 100 -
23 senderDeptName 발신자 부서명 String 40 -
24 senderTEL 발신자 연락처 String 20 -
25 senderTEL 발신자 휴대전화 String 20 -
26 senderHP 발신자 이메일주소 String 100 -
27 senderFAX 발신자 팩스번호 String 20 -
28 receiverCorpNum 수신자 사업자번호 String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
29 receiverTaxRegID 수신자 종사업장번호 String 4 - 숫자 4자리 기재
30 receiverCorpName 수신자 상호 String 200 -
31 receiverCEOName 수신자 대표자성명 String 100 -
32 receiverAddr 수신자 주소 String 300 -
33 receiverBizType 수신자 업태 String 100 -
34 receiverBizClass 수신자 종목 String 100 -
35 receiverContactName 수신자 성명 String 100 O
36 receiverDeptName 수신자 부서명 String 40 -
37 receiverTEL 수신자 연락처 String 20 -
38 receiverTEL 수신자 휴대전화 String 20 -
39 receiverHP 수신자 이메일주소 String 100 -
40 receiverFAX 수신자 팩스번호 String 20 -
41 propertyBag 추가속성 String - - 문서종류별 추가적인 속성을 "Key", "Value" 형식의 객체로 정의
[부록] "기본양식 추가속성 테이블"
42 businessLicenseYN 사업자등록증 첨부 여부 boolean - - 사업자등록증이 등록되어 있어야 사용 가능
43 bankBookYN 통장사본 첨부 여부 boolean - - 통장사본이 등록되어 있어야 사용 가능
44 smssendYN 문자 자동전송 여부 boolean - - 미기재시 기본값은 'False'
45 autoAcceptYN 발행시 자동승인 여부 boolean - - 수신자의 승인여부와 관계없이 발행 - 미기재시 기본값은 'False'
46 detailList 상세항목 StatementDetail[] - [배열] 길이 제한 없음

A.4. StatementDetail

순번 변수명 항목명 타입 길이 필수 비고
1 serialNum 일련번호 Integer - O 1부터 순차기재, 99개 까지 가능
2 purchaseDT 거래일자 String 8 - 거래일자 yyyyMMdd ('-' 제외)
3 itemName 품명 String 100 -
4 spec 규격 String 60 -
5 qty 수량 String 12 - 소수점 2 자리까지 기재 가능
6 unitCost 단가 String 18 - 소수점 2 자리까지 기재 가능
7 supplyCost 공급가액 String 18 - 소수점 기재 불가, 원단위 이하는 절사
8 tax 세액 String 18 - 소수점 기재 불가, 원단위 이하는 절사
9 remark 비고 String 100 -
10 spare1 여분1 String 100 -
11 spare2 여분2 String 100 -
12 spare3 여분3 String 100 -
13 spare4 여분4 String 100 -
14 spare5 여분5 String 100 -
15 spare6 여분6 String 100 -
16 spare7 여분7 String 100 -
17 spare8 여분8 String 100 -
18 spare9 여분9 String 100 -
19 spare10 여분10 String 100 -
20 spare11 여분11 String 100 -
21 spare12 여분12 String 100 -
22 spare13 여분13 String 100 -
23 spare14 여분14 String 100 -
24 spare15 여분15 String 100 -
25 spare16 여분16 String 100 -
26 spare17 여분17 String 100 -
27 spare18 여분18 String 100 -
28 spare19 여분19 String 100 -
29 spare20 여분20 String 100 -

A.5. StmtSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 Integer -
2 message 요청에 대한 응답메시지 String -
3 total 총 검색결과 건수 String -
4 perPage 페이지당 검색개수 String -
5 pageNum 페이지 번호 String -
6 pageCount 페이지 개수 String -
7 list 전자명세서 상태/요약정보 StatementInfo[] [배열] 최대 1,000개, 상태 확인(GetInfo API) 응답전문의 구성과 동일

A.6. StatementInfo

순번 변수명 항목명 타입 길이 비고
1 itemCode 문서종류코드 Integer 3 거래명세서 종류코드
121 : 거래명세서
122 : 청구서
123 : 견적서
124 : 발주서
125 : 입금표
126 : 영수증
2 itemKey 팝빌번호 String 18 팝빌이 부여한 식별번호
3 invoiceNum 팝빌승인번호 String 24 팝빌이 부여한 팝빌승인번호
4 mgtKey 파트너 문서번호 String 24 파트너가 부여한 문서번호
5 taxType 과세형태 String 2 과세, 영세, 면세 중 반환
6 writeDate 작성일자 String 8 날짜형식(yyyyMMdd)
7 regDT 임시저장일시 String 14 날짜형식(yyyyMMddHHmmss)
8 senderCorpName 발신자 상호 String 200
9 senderCorpNum 발신자 사업자번호 String 10
10 senderPrintYN 발신자 인쇄여부 boolean - True-인쇄 / False-미인쇄
11 receiverCorpName 수신자 상호 String 200
12 receiverCorpNum 수신자 사업자번호 String 10
13 receiverPrintYN 수신자 인쇄여부 boolean - True-인쇄 / False-미인쇄
14 supplyCostTotal 공급가액 합계 String 18
15 taxTotal 세액 합계 String 18
16 purposeType 영수/청구 String 2 영수, 청구 중 반환
17 issueDT 발행일시 String 14 날짜형식(yyyyMMddHHmmss)
18 stateCode 상태코드 Integer 3 [부록] "전자명세서 상태코드"
19 stateDT 상태 변경일시 String 14 날짜형식(yyyyMMddHHmmss)
20 stateMemo 상태메모 String 200
21 openYN 개봉 여부 boolean - True-개봉 / False-미개봉
22 openDT 개봉 일시 String 14 날짜형식(yyyyMMddHHmmss)

A.7. StatementLog

순번 변수명 항목명 타입 길이 비고
1 docLogType 로그타입 Integer 3
2 log 이력정보 String 2000
3 procType 처리형태 String 3
4 procMemo 처리메모 String 200
5 regDT 등록일시 String 14
6 ip 아이피 String 39

A.8. AttachedFile

순번 변수명 항목명 타입 길이 비고
1 serialNum 첨부파일 일련번호 Integer 1
2 attachedFile 파일아이디 String 255 첨부파일 삭제시 사용
3 displayName 첨부파일명 String 255
4 regDT 첨부일시 String 14

A.9. EmailSendConfig

순번 변수명 항목명 타입 길이 비고
1 emailType 메일전송유형 String -

SMT_ISSUE : 수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT : 발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY : 발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL : 수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE : 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일

2 sendYN 전송여부 String - True-전송 / False-미전송

A.10. ChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 발행단가 String - 발행단가 반환
2 chargeMethod 과금유형 String - 일반, 연동, 파트너 중 반환
3 rateSystem 과금제도 String - 종량제 반환

A.11. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 미만
2 PWD 비밀번호 String 20 O 6자 이상 20자 미만
3 LinkID 파트너 링크아이디 String 20 O 파트너 신청시 메일로 발급받은 링크아이디
4 CorpNum 사업자번호 String 10 O 사업자번호 (하이픈 '-' 제외 10 자리)
5 CEOName 대표자 성명 String 100 O
6 CorpName 상호 String 200 O
7 Addr 사업장 주소 String 300 O
8 BizType 업태 String 100 O
9 BizClass 종목 String 100 O
10 ContactName 담당자 성명 String 100 O
11 ContactEmail 담당자 이메일 String 100 O
12 ContactTEL 담당자 연락처 String 20 O
13 ContactHP 담당자 휴대폰번호 String 20 -
14 ContactFAX 담당자 팩스번호 String 20 -

A.12. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 String 100 O
2 corpName 상호 String 200 O
3 addr 주소 String 300 O
4 bizType 업태 String 100 O
5 bizClass 종목 String 100 O

A.13. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 O 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처 String 20 -
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 -
9 searchAllAllowYN 담당자 조회권한 설정 boolean - O

회사조회(True) : 모든 담당자의 전자문서 관리가능

개인조회(False) : 해당 담당자 계정으로 작성한 전자문서 관리가능

10 mgrYN 관리자 여부 boolean - O True-관리자 / False-사용자
11 state 상태 Integer 1 - 0–승인대기 / 1–사용중