팝빌 연동매뉴얼

Index

1. 전자명세서 발행
2. 전자명세서 정보확인
3. 전자명세서 보기/인쇄
4. 부가기능
5. 포인트 관리
6. 회원정보
A. 객체정보

Usage statementService

var popbill = require('popbill');

popbill.config({

    // 링크허브에서 발급받은 링크아이디, 비밀키
    LinkID: 'TESTID',
    SecretKey: 'SwW2qU+1TEzYBx/6TVjIPGnI0VXUMMQQZtJf2Ed8q2I=',

    // 연동환경 설정값, (true-개발용, false-상업용)
    IsTest: true

    // 인증토큰 IP제한기능 사용여부, 권장(true)
    IPRestrictOnOff: true,

    defaultErrorHandler: function (Error) {
        console.log('Error Occur : [' + Error.code + '] ' + Error.message);
    }
});

var statementService = popbill.StatementService();

1. 전자명세서 발행

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

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

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

statementService.checkMgtKeyInUse(CorpNum, ItemCode, MgtKey, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	success	Function	-	O	성공에 대한 콜백 함수
5	error	Function	-	O	실패에 대한 콜백 함수

Return

boolean > true : (사용중)

Throws

PopbillException의 code > -12000004 : (미사용중)

Throws

PopbillException

1.2. RegistIssue - 즉시 발행

ㆍ작성된 전자명세서 데이터를 팝빌에 저장과 동시에 발행하여, "발행완료" 상태로 처리합니다.

ㆍ팝빌 사이트 [전자명세서] > [환경설정] > [전자명세서 관리] 메뉴의 발행시 자동승인 옵션 설정을 통해 전자명세서를 "발행완료" 상태가 아닌 "승인대기" 상태로 발행 처리 할 수 있습니다.

statementService.function(CorpNum, Statement, Memo, UserID, EmailSubject, success, error)

유의사항

ㆍ전자명세서 즉시 발행 함수 호출시 포인트가 과금되며, 수신자에게 발행 안내 메일이 발송됩니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	Statement	Statement	-	O	전자명세서 객체정보
3	Memo	string	200	-	전자명세서 상태 이력을 관리하기 위한 메모
4	UserID	string	50	-	팝빌회원 아이디
5	EmailSubject	string	300	-	전자명세서 발행 안내메일 제목 ※ 미입력시 팝빌에서 지정한 이메일 제목으로 전송
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

IssueResponse

Throws

PopbillException

1.3. Register - 임시저장

ㆍ작성된 전자명세서 데이터를 팝빌에 저장합니다.

ㆍ"임시저장" 상태의 전자명세서는 [1.5. Issue - 발행]함수를 호출하여 "발행완료" 처리한 경우에만 수신자에게 발행 안내 메일이 발송됩니다.

statementService.register(CorpNum, Statement, UserID, success, error)

ㆍ임시저장된 전자명세서는 팝빌 사이트 '임시문서함'에서 확인 가능합니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	Statement	Statement	-	O	전자명세서 객체정보
3	UserID	string	50	-	팝빌회원 아이디
4	success	Function	-	O	성공에 대한 콜백 함수
5	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

1.4. Update - 수정

ㆍ"임시저장" 상태의 전자명세서를 수정합니다.

statementService.update(CorpNum, ItemCode, MgtKey, Statement, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	Statement	Statement	-	O	전자명세서 객체정보
5	UserID	string	50	-	팝빌회원 아이디
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

1.5. Issue - 발행

ㆍ"임시저장" 상태의 전자명세서를 발행하여, "발행완료" 상태로 처리합니다.

statementService.issue(CorpNum, ItemCode, MgtKey, Memo, EmailSubject, UserID, success, error)

유의사항

ㆍ전자명세서 발행 함수 호출시 포인트가 과금되며, 수신자에게 발행 안내 메일이 발송됩니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	Memo	string	200	-	메모, 상태확인(GetInfo API) stateMemo(상태메모) 확인 가능
5	EmailSubject	string	300	-	전자명세서 발행 안내메일 제목 ※ 미입력시 팝빌에서 지정한 이메일 제목으로 전송
6	UserID	string	50	-	팝빌회원 아이디
7	success	Function	-	O	성공에 대한 콜백 함수
8	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

1.6. Cancel - 발행취소

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

ㆍ"발행취소" 상태의 전자명세서를 [1.7. Delete - 삭제]함수 이용하면, 전자명세서 관리를 위해 부여했던 문서번호를 재사용 할 수 있습니다.

statementService.cancel(CorpNum, ItemCode, MgtKey, Memo, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	Memo	string	200	-	전자명세서 상태 이력을 관리하기 위한 메모
5	UserID	string	50	-	팝빌회원 아이디
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

1.7. Delete - 삭제

ㆍ삭제 가능한 상태의 전자명세서를 삭제합니다.

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

statementService.delete(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

2. 전자명세서 정보확인

2.1. GetInfo - 상태 확인

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

statementService.getInfo(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

StatementInfo

Throws

PopbillException

2.2. GetInfos - 다수건 상태 확인

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

statementService.getInfos(CorpNum, ItemCode, MgtKeyList, UserID, success, error)

ㆍ문서번호를 통해 전자명세서 목록을 구현하는 경우 활용합니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKeyList	object	1000	O	[배열] 조회할 전자명세서 문서번호 (최대 1,000건)
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

StatementInfo[ ]

Throws

PopbillException

2.3. GetDetailInfo - 상세정보 확인

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

statementService.getDetailInfo(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

Statement

Throws

PopbillException

2.4. Search - 목록 조회

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

statementService.search(CorpNum, DType, SDate, EDate, State, ItemCode, Qstring, Order, Page, PerPage, success, error)

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

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	DType	string	1	O	조회 기준일자 유형 : "R" / "W" / "I" 중 택 1 └ R = 등록일자, W = 작성일자, I = 발행일자
3	SDate	string	8	O	조회 기간의 시작일자 (형식 : yyyyMMdd)
4	EDate	string	8	O	조회 기간의 종료일자 (형식 : yyyyMMdd)
5	State	object	-	O	[배열] 전자명세서 상태코드 └ 2,3번째 자리에 와일드카드() 사용가능, 예) "1", "3*" [참고] 전자명세서 상태코드 ※ 미입력시 전체조회
6	ItemCode	object	-	O	[배열] 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 선택 (다중 선택 가능) └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
7	QString	string	-	O	거래처 상호 / 사업자번호 중 검색하고자 하는 정보 입력 ※ 미입력시 전체조회
8	Order	string	1	O	정렬 방향, 기본값 'D' [ D-내림차순, A-오름차순 중 택1 ]
9	Page	number	-	-	목록 페이지번호 (기본값 1)
10	PerPage	number	-	-	페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
11	success	Function	-	O	성공에 대한 콜백 함수
12	error	Function	-	O	실패에 대한 콜백 함수

Return

StmtSearchResult

Throws

PopbillException

2.5. GetLogs - 전자명세서 상태 변경이력 확인

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

statementService.getLogs(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

StatementLog[ ]

Throws

PopbillException

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

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

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getURL(CorpNum, TOGO, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	TOGO	string	-	O	접근 메뉴 : "TBOX" / "SBOX" 중 택 1 └ TBOX = 임시 문서함, / SBOX = 매출 문서함
3	UserID	string	50	-	팝빌회원 아이디
4	success	Function	-	O	성공에 대한 콜백 함수
5	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

3.1. GetPopUpURL - 전자명세서 상세 정보 팝업 URL

ㆍ팝빌 사이트와 동일한 전자명세서 1건의 상세 정보 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getPopUpURL(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.2. GetViewURL - 전자명세서 상세 정보 팝업 URL [메뉴/버튼 제외]

ㆍ팝빌 사이트와 동일한 전자명세서 1건의 상세 정보 페이지(사이트 상단, 좌측 메뉴 및 버튼 제외)의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getViewURL(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ전자명세서 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환하며, 페이지내에서 인쇄 설정값을 "공급자" / "공급받는자" / "공급자+공급받는자"용 중 하나로 지정할 수 있습니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getPrintURL(CorpNum, ItemCode, MgtKey, UserID, success, error)

유의사항

ㆍ전자명세서의 공급자는 "발신자", 공급받는자는 "수신자"를 나타내는 용어입니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ"공급받는자" 용 전자명세서 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getEPrintURL(CorpNum, ItemCode, MgtKey, UserID, success, error)

유의사항

ㆍ전자명세서의 공급받는자는 "수신자"를 나타내는 용어입니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.5. GetMassPrintURL - 전자명세서 대량 인쇄 팝업 URL

ㆍ다수건의 전자명세서를 인쇄하기 위한 페이지의 팝업 URL을 반환합니다. (최대 100건)

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getMassPrintURL(CorpNum, ItemCode, MgtKeyList, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKeyList	object	100	O	[배열] 인쇄할 전자명세서 문서번호 (최대 100건)
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.6. GetMailURL - 전자명세서 안내메일 버튼 팝업 URL

ㆍ안내메일과 관련된 전자명세서를 확인 할 수 있는 상세 페이지의 팝업 URL을 반환하며, 해당 URL은 메일 하단의 파란색 버튼의 링크와 같습니다.

ㆍ함수 호출로 반환 받은 URL에는 유효시간이 없습니다.

statementService.getMailURL(CorpNum, ItemCode, MgtKey, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

4. 부가기능

4.1. GetAccessURL - 팝빌 로그인 팝업 URL

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

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getAccessURL(CorpNum, UserID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	callback	Function	-	O	성공에 대한 콜백 함수
4	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

4.2. AttachFile - 파일 첨부

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

statementService.attachFile(CorpNum, ItemCode, MgtKey, DisplayName, FilePaths, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	DisplayName	string	-	O	첨부파일명
5	FilePaths	object	-	O	첨부파일 경로
6	UserID	string	50	-	팝빌회원 아이디
7	success	Function	-	O	성공에 대한 콜백 함수
8	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.3. DeleteFile - 첨부파일 삭제

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

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

statementService.deleteFile(CorpNum, ItemCode, MgtKey, FileID, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	FileID	string	255	O	팝빌이 첨부파일 관리를 위해 할당하는 식별번호 └ 함수 [4.5. GetFiles – 첨부파일 목록 확인]의 리턴값 중 'attachedFile' 필드 참조
5	UserID	string	50	-	팝빌회원 아이디
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

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

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

statementService.getFiles(CorpNum, ItemCode, MgtKey, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	success	Function	-	O	성공에 대한 콜백 함수
5	error	Function	-	O	실패에 대한 콜백 함수

Return

AttachedFile[ ]

Throws

PopbillException

4.5. SendEmail - 메일 재전송

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

statementService.sendEmail(CorpNum, ItemCode, MgtKey, Receiver, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	이메일 재전송할 전자명세서 문서번호
4	Receiver	string	-	O	수신자 이메일주소
5	UserID	string	50	-	팝빌회원 아이디
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.6. SendSMS - 문자 재전송

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

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

statementService.sendSMS(CorpNum, ItemCode, MgtKey, Sender, Receiver, Contents, UserID, success, error)

유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	Sender	string	-	O	발신번호
5	Receiver	string	-	O	수신번호
6	Contents	string	90	O	메시지 내용 ※ 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
7	UserID	string	50	-	팝빌회원 아이디
8	success	Function	-	O	성공에 대한 콜백 함수
9	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.7. SendFAX - 팩스 전송

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

statementService.sendFAX(CorpNum, ItemCode, MgtKey, Sender, Receiver, UserID, success, error)

유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	Sender	string	-	O	발신번호
5	Receiver	string	-	O	수신번호
6	UserID	string	50	-	팝빌회원 아이디
7	success	Function	-	O	성공에 대한 콜백 함수
8	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.8. FAXSend - 선팩스 전송

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

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

statementService.FAXSend(CorpNum, Statement, sendNum, receiveNum, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	Statement	Statement	-	O	전자명세서 객체정보
3	sendNum	string	-	O	발신번호
4	receiveNum	string	-	O	수신번호
5	UserID	string	50	-	팝빌회원 아이디
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.9. AttachStatement - 전자명세서 첨부

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

statementService.attachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	SubItemCode	number	3	O	첨부할 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
5	SubMgtKey	string	24	O	첨부할 전자명세서 문서번호
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

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

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

statementService.detachStatement(CorpNum, ItemCode, MgtKey, SubItemCode, SubMgtKey, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	MgtKey	string	24	O	파트너가 할당한 문서번호
4	SubItemCode	number	3	O	첨부해제할 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 선택 (다중 선택 가능) └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
5	SubMgtKey	string	24	O	첨부해제할 전자명세서 문서번호
6	success	Function	-	O	성공에 대한 콜백 함수
7	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

4.11. ListEmailConfig - 전자명세서 알림메일 발송설정 조회

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

statementService.listEmailConfig(CorpNum, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	success	Function	-	O	성공에 대한 콜백 함수
4	error	Function	-	O	실패에 대한 콜백 함수

Return

EmailSendConfig[ ]

Throws

PopbillException

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

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

statementService.updateEmailConfig(CorpNum, EmailType, SendYN, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	EmailType	string	-	O	* 메일 전송 유형 SMT_ISSUE : 수신자에게 전자명세서가 발행 되었음을 알려주는 메일 SMT_ACCEPT : 발신자에게 전자명세서가 승인 되었음을 알려주는 메일 SMT_DENY : 발신자에게 전자명세서가 거부 되었음을 알려주는 메일 SMT_CANCEL : 수신자에게 전자명세서가 취소 되었음을 알려주는 메일 SMT_CANCEL_ISSUE : 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
3	SendYN	boolean	-	O	전송 여부
4	UserID	string	50	-	팝빌회원 아이디
5	success	Function	-	O	성공에 대한 콜백 함수
6	error	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

5. 포인트 관리

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

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

statementService.getBalance(CorpNum, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 연동회원 잔여포인트

Throws

PopbillException

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

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getChargeURL(CorpNum, UserID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	callback	Function	-	O	성공에 대한 콜백 함수
4	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

5.3. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL

ㆍ연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getPaymentURL(CorpNum, UserID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	callback	Function	-	O	성공에 대한 콜백 함수
4	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

5.4. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL

ㆍ연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getUseHistoryURL(CorpNum, UserID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	callback	Function	-	O	성공에 대한 콜백 함수
4	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

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

statementService.getPartnerBalance(CorpNum, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 파트너 잔여포인트

Throws

PopbillException

5.6. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

statementService.getPartnerURL(CorpNum, TOGO, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	TOGO	string	-	O	"CHRG" 입력
3	callback	Function	-	O	성공에 대한 콜백 함수
4	err	Function	-	O	실패에 대한 콜백 함수

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

5.7. GetUnitCost - 발행 단가 확인

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

statementService.getUnitCost(CorpNum, ItemCode, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	확인할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	success	Function	-	O	성공에 대한 콜백 함수
4	error	Function	-	O	실패에 대한 콜백 함수

Return

string - 전자명세서 발행단가

Throws

PopbillException

5.8. GetChargeInfo - 과금정보 확인

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

statementService.getChargeInfo(CorpNum, ItemCode, UserID, success, error)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ItemCode	number	3	O	확인할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
3	UserID	string	50	-	팝빌회원 아이디
4	success	Function	-	O	성공에 대한 콜백 함수
5	error	Function	-	O	실패에 대한 콜백 함수

Return

ChargeInfo

Throws

PopbillException

6. 회원정보

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

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

statementService.checkIsMember(CorpNum, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

Response - code : 0 (미가입) / code : 1 (가입)

Throws

PopbillException

6.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

statementService.checkID(targetID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	targetID	string	10	O	중복여부를 확인할 아이디
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

Response - code : 0 (미사용중) / code : 1 (사용중)

Throws

PopbillException

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

ㆍ사용자를 연동회원으로 가입처리합니다.

statementService.joinMember(JoinForm, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	JoinInfo	JoinForm	-	O	연동회원 객체정보
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

6.4. GetCorpInfo - 회사정보 확인

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

statementService.getCorpInfo(CorpNum, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

CorpInfo

Throws

PopbillException

6.5. UpdateCorpInfo - 회사정보 수정

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

statementService.updateCorpInfo(CorpNum, UserID, CorpInfo, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	CorpInfo	CorpInfo	-	O	회사정보 객체
4	callback	Function	-	O	성공에 대한 콜백 함수
5	err	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

6.6. RegistContact - 담당자 추가

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

statementService.registContact(CorpNum, UserID, ContactInfo, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	ContactInfo	ContactInfo	-	O	담당자 객체정보
4	callback	Function	-	O	성공에 대한 콜백 함수
5	err	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

6.7. GetContactInfo - 담당자 정보 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 확인합니다.

statementService.getContactInfo(CorpNum, ContactID, UserID, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	ContactID	string	50	O	담당자 아이디
3	UserID	string	50	-	팝빌회원 아이디
4	callback	Function	-	O	성공에 대한 콜백 함수
5	err	Function	-	O	실패에 대한 콜백 함수

Return

ContactInfo

Throws

PopbillException

6.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

statementService.listContact(CorpNum, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	callback	Function	-	O	성공에 대한 콜백 함수
3	err	Function	-	O	실패에 대한 콜백 함수

Return

ContactInfo[ ]

Throws

PopbillException

6.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

statementService.updateContact(CorpNum, UserID, ContactInfo, callback, err)

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	O	팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2	UserID	string	50	-	팝빌회원 아이디
3	ContactInfo	ContactInfo	-	O	담당자 객체정보
4	callback	Function	-	O	성공에 대한 콜백 함수
5	err	Function	-	O	실패에 대한 콜백 함수

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

순번	변수명	항목명	타입	길이	비고
1	code	코드	number	-	API 처리에 대한 응답코드
2	message	메시지	string	-	API 처리에 대한 응답메시지

A.2. IssueResponse

순번	변수명	항목명	타입	길이	비고
1	code	코드	number	-	API 처리에 대한 응답코드
2	message	메시지	string	-	API 처리에 대한 응답메시지
3	invoiceNum	팝빌 승인번호	string	24	전자명세서 발행 시점에 팝빌에서 자동으로 부여

A.3. PopbillException

순번	변수명	항목명	타입	길이	비고
1	code	코드	number	-	API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값) └ [참고] 오류코드
2	message	메시지	string	-	API 처리 실패에 대한 오류메시지

A.4. Statement

순번	변수명	항목명	타입	길이	필수	비고
1	itemCode	명세서 코드	number	3	O	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1 └ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
2	mgtKey	문서번호	string	24	O	전자명세서 관리를 위해 파트너가 할당하는 식별번호 └ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
3	invoiceNum	팝빌 승인번호	string	24	X	팝빌에서 전자명세서 발행을 완료하고 할당한 식별번호
4	formCode	맞춤양식 코드	string	8	-	※ 미입력시 팝빌 기본양식 적용
5	writeDate	작성일자	string	8	O	형식 : yyyyMMdd
6	taxType	과세형태	string	4	O	"과세" / "영세" / "면세" 중 택 1
7	purposeType	영수/청구	string	-	-	"영수" / "청구" / "없음" 중 택 1
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	하이픈('-') 제외 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	O	하이픈('-') 제외 10자리 숫자값
29	receiverTaxRegID	수신자 종사업장번호	string	4	-	숫자 4자리 입력
30	receiverCorpName	수신자 상호	string	200	O
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	-	{@no.44 smssendYN} 값이 true 인 경우 이 값으로 안내 문자 전송
38	receiverHP	수신자 휴대전화	string	20	-
39	receiverEmail	수신자 이메일주소	string	100	-	전자명세서 발행 안내 메일 발송되는 주소값
40	receiverFAX	수신자 팩스번호	string	20	-
41	propertyBag	추가속성	object	-	-	전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력 └ [참고] 기본양식 추가속성 테이블 └ [참고] 전자명세서 튜토리얼
42	businessLicenseYN	사업자등록증 첨부 여부	boolean	-	-	팝빌에 등록된 사업자등록증 첨부 여부 : true / false 중 택 1 └ true = 첨부, false = 미첨부(기본값) ※ 팝빌 사이트 [마이페이지 > 좌측메뉴 > 회사정보 > 인감 및 첨부문서 관리]에서 등록 가능
43	bankBookYN	통장사본 첨부 여부	boolean	-	-	팝빌에 등록된 통장사본 첨부 여부 : true / false 중 택 1 └ true = 첨부, false = 미첨부(기본값) ※ 팝빌 사이트 [마이페이지 > 좌측메뉴 > 회사정보 > 인감 및 첨부문서 관리]에서 등록 가능
44	smssendYN	문자 자동전송 여부	boolean	-	-	true : (전송) / false : (미전송) ※ 미입력시 기본값 false 처리
45	detailList	상세항목	StatementDetail[ ]		-	[배열] 거래 물품 상세 정보 ※ 길이 제한 없음

A.5. StatementDetail

순번	변수명	항목명	타입	길이	필수	비고
1	serialNum	일련번호	number	-	O	1부터 순차적으로 입력
2	purchaseDT	거래일자	string	8	-	형식 : yyyyMMdd
3	itemName	품명	string	100	-
4	spec	규격	string	60	-
5	qty	수량	string	12	-
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.6. StmtSearchResult

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

A.7. StatementInfo

순번	변수명	항목명	타입	길이	비고
1	itemCode	문서종류코드	number	3	전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 반환 └ 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	상태코드	number	3	[참고] 전자명세서 상태코드
19	stateDT	상태 변경일시	string	14	형식 : yyyyMMddHHmmss
20	stateMemo	상태메모	string	200
21	openYN	개봉 여부	boolean	-	true : (개봉) / false : (미개봉) 중 반환
22	openDT	개봉 일시	string	14	형식 : yyyyMMddHHmmss

A.8. StatementLog

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

A.9. AttachedFile

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

A.10. EmailSendConfig

순번	변수명	항목명	타입	길이	비고
1	emailType	메일전송유형	string	-	SMT_ISSUE : 수신자에게 전자명세서가 발행 되었음을 알려주는 메일 SMT_ACCEPT : 발신자에게 전자명세서가 승인 되었음을 알려주는 메일 SMT_DENY : 발신자에게 전자명세서가 거부 되었음을 알려주는 메일 SMT_CANCEL : 수신자에게 전자명세서가 취소 되었음을 알려주는 메일 SMT_CANCEL_ISSUE : 수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일
2	sendYN	전송여부	boolean	-	true : (전송) / false : (미전송)

A.11. ChargeInfo

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

A.12. JoinForm

순번	변수명	항목명	타입	길이	필수	비고
1	ID	아이디	string	50	O	6자 이상 50자 미만
2	Password	비밀번호	string	20	O	8자 이상 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.13. 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.14. ContactInfo

순번	변수명	항목명	타입	길이	필수	비고
1	id	아이디	string	50	O	6자 이상 50자 미만
2	Password	비밀번호	string	20	△	8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합
3	personName	담당자 성명	string	100	O
4	tel	담당자 연락처(전화번호)	string	20	O
5	hp	담당자 휴대폰번호	string	20	-
6	fax	담당자 팩스번호	string	20	-
7	email	담당자 이메일	string	100	O
8	regDT	등록일시	string	14	X
9	searchRole	담당자 권한	number	1	-	1 / 2 / 3 중 입력 또는 반환 └ 1 : 개인권한 / 2 : 읽기권한 / 3 : 회사권한
10	mgrYN	관리자 여부	Boolean	-	X	true : (관리자) / false : (비관리자) 중 반환 ※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11	state	계정상태	number	1	X	0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환