정보확인

1. GetInfo - 상태 확인

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

Function GetInfo(CorpNum As String, itemCode As Integer, mgtKey As String, Optional UserID As String = "") As PBDocInfo

요청

Parameters

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

응답

PBDocInfo

순번	변수명	타입	길이	설명
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

예외

Err

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

2. GetInfos - 다수건 상태 확인

다수건의 전자명세서 상태 및 요약정보를 확인합니다. (1회 호출에 최대 1,000건 확인 가능)

Function GetInfos(CorpNum As String, itemCode As Integer, MgtKeyList As Collection, Optional UserID As String = "") As Collection

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	itemCode	Integer	3	Y	전자명세서 문서 유형 (택 1) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
3	MgtKeyList	Collection	1,000	Y	문서번호 목록 → 최대 : 1,000건
4	UserID	String	50	N	팝빌회원 아이디

응답

PBDocInfo

순번	변수명	타입	길이	설명
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

예외

Err

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

3. GetDetailInfo - 상세정보 확인

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

Function GetDetailInfo(CorpNum As String, itemCode As Integer, mgtKey As String, Optional UserID As String = "") As PBStatement

요청

Parameters

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

응답

PBStatement

순번	변수명	타입	길이	설명
1	itemCode	Integer	3	전자명세서 문서 유형 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증
2	mgtKey	String	24	문서번호 → 전자명세서 관리를 위해 파트너가 할당하는 식별번호
3	invoiceNum	String	24	팝빌 승인번호 → 전자명세서 발행 시점에 팝빌에서 자동으로 할당
4	formCode	String	8	맞춤양식 코드
5	writeDate	String	8	작성일자 → 형식 : yyyyMMdd
6	taxType	String	2	과세형태 과세 영세 면세 ✓ {itemCode}=121 경우 반환
7	purposeType	String	2	영수/청구 영수 청구 없음
8	serialNum	String	30	일련번호
9	supplyCostTotal	String	18	공급가액 합계
10	taxTotal	String	18	세액 합계
11	totalAmount	String	18	합계금액
12	remark1	String	150	비고 1
13	remark2	String	150	비고 2
14	remark3	String	150	비고 3
15	senderCorpNum	String	10	발신자 사업자번호 ('-' 제외)
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	senderHP	String	20	발신자 휴대전화
26	senderEmail	String	100	발신자 메일주소
27	senderFAX	String	20	발신자 팩스번호
28	receiverCorpNum	String	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	수신자 성명
36	receiverDeptName	String	40	수신자 부서명
37	receiverTEL	String	20	수신자 연락처
38	receiverHP	String	20	수신자 휴대전화
39	receiverEmail	String	100	수신자 메일주소
40	receiverFAX	String	20	수신자 팩스번호
41	businessLicenseYN	Boolean	-	팝빌에 등록된 사업자등록증 첨부 여부 True 첨부 False 미첨부
42	bankBookYN	Boolean	-	팝빌에 등록된 통장사본 첨부 여부 True 첨부 False 미첨부
43	smssendYN	Boolean	-	알림문자 전송 여부 True 전송 False 미전송 → 수신자 : 수신자 휴대폰번호 {receiverHP}
44	propertyBag	Dictionary	-	추가속성 → 전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력 [참고] 기본양식 추가속성
45	detailList	PBDocDetail[ ]	-	거래 물품 상세 정보 → 길이 제한 없음
PBDocDetail[ ] 순번 변수명 타입 길이 설명 1 serialNum Integer - 일련번호 → 1부터 순차적으로 입력 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 String 100 여분1 11 spare2 String 100 여분2 12 spare3 String 100 여분3 13 spare4 String 100 여분4 14 spare5 String 100 여분5 15 spare6 String 100 여분6 16 spare7 String 100 여분7 17 spare8 String 100 여분8 18 spare9 String 100 여분9 19 spare10 String 100 여분10 20 spare11 String 100 여분11 21 spare12 String 100 여분12 22 spare13 String 100 여분13 23 spare14 String 100 여분14 24 spare15 String 100 여분15 25 spare16 String 100 여분16 26 spare17 String 100 여분17 27 spare18 String 100 여분18 28 spare19 String 100 여분19 29 spare20 String 100 여분20

예외

Err

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

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

파트너가 전자명세서 관리 목적으로 할당하는 문서번호의 사용여부를 확인합니다.

• 이미 사용 중인 문서번호는 중복 사용이 불가하고, 전자명세서가 삭제된 경우에만 문서번호의 재사용이 가능합니다.

Function CheckMgtKeyInUse(CorpNum As String, itemCode As Integer, mgtKey As String) As PBResponse

요청

Parameters

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

응답

PBResponse

순번	변수명	타입	길이	설명
1	code	Long	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	invoiceNum	String	24	팝빌 승인번호 → 전자명세서 발행 시점에 팝빌에서 자동으로 할당 RegistIssue API 사용할 경우만 존재

예외

Err

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

5. Search - 목록 조회

검색조건에 해당하는 전자명세서를 조회합니다. (최대 조회기간 : 6개월)

Function Search(CorpNum As String, DType As String, SDate As String, EDate As String, state As Collection, itemCode As Collection, Page As Integer, PerPage As Integer, Order As String, Optional QString As String) As Collection

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	DType	String	1	Y	검색일자 유형 (택 1) R 등록일자 W 작성일자 I 발행일자
3	SDate	String	8	Y	검색 시작일자 → 형식 : yyyyMMdd
4	EDate	String	8	Y	검색 종료일자 → 형식 : yyyyMMdd
5	state	Collection	-	N	전자명세서 상태코드 → 2, 3번째 자리에 와일드카드(*) 사용가능. 예) "1**", "3**" [참고] 팝빌 상태코드 ※ 기본값 : 전체조회
6	itemCode	Collection	-	N	전자명세서 문서 유형 (다중 선택 가능) 121 거래명세서 122 청구서 123 견적서 124 발주서 125 입금표 126 영수증 ※ 기본값 : 전체조회
7	Page	Integer	-	N	목록 페이지번호 ※ 기본값 : 1
8	PerPage	Integer	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
9	Order	String	1	Y	조회 기준일자 유형을 기준으로 하는 목록 정렬 방향 D 내림차순 : 기본값 A 오름차순
10	QString	String	-	N	조회 검색어(거래처 상호/사업자번호) ※ 기본값 : 전체조회

응답

PBDocSearchList

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	total	Integer	-	총 검색결과 건수
4	perPage	Integer	-	페이지당 목록 건수
5	pageNum	Integer	-	페이지 번호
6	pageCount	Integer	-	페이지 개수
7	list	PBDocInfo[ ]	-	전자명세서 상태/요약정보 → 함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일 최대 1,000건
PBDocInfo[ ] 순번 변수명 타입 길이 설명 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

예외

Err

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

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

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

Function GetLogs(CorpNum As String, itemCode As Integer, mgtKey As String, Optional UserID As String = "") As Collection

요청

Parameters

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

응답

PBDocLog

순번	변수명	타입	길이	설명
1	docLogType	Integer	3	로그타입 100 임시저장 101 수정 102 개봉 103 수신확인 111 메일 재전송 112 문자 재전송 113 팩스 재전송 122 문자 전송결과 123 팩스 전송결과 310 발행 312 자동승인 340 발행취소
2	log	String	2000	이력정보
3	procType	String	3	처리형태 연동 API를 통해 처리함 일반 팝빌 사이트를 통해 처리함 시스템 팝빌이 처리함
4	procMemo	String	200	처리메모
5	regDT	String	14	등록일시 → 형식 : yyyyMMddHHmmss
6	ip	String	39	아이피

예외

Err

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

7. GetURL - 문서함 팝업 URL

미리보기

전자명세서 문서함의 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,280px (최소 1,000px) / height = 800px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL은 팝빌회원의 로그인 세션을 포함하고 있으니 사용에 유의하여 주시기 바랍니다.

Function GetURL(CorpNum As String, UserID As String, TOGO As String) As String

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	String	50	N	팝빌회원 아이디
3	TOGO	String	-	Y	접근 메뉴 (택 1) TBOX 임시 문서함 SWBOX 발행 문서함

응답

String - 요청에 대한 응답 URL

예외

Err

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