Index

1. 현금영수증 발행

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

ㆍ현금영수증 문서번호 사용여부를 확인합니다.

ㆍ문서번호란 현금영수증을 고유하게 구별하기 위해 부여하는 값으로 파트너가 할당하는 기본키(Primary Key) 역할을 합니다.

bool CheckMgtKeyInUse(string CorpNum, string MgtKey, string UserID = null)

개발 유의사항
ㆍ사용중인 문서번호는 새로운 현금영수증 발행(Issue) 또는 임시저장(Register)시 할당이 불가합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

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

Throws

PopbillException

1.2. RegistIssue - 즉시 발행

ㆍ현금영수증을 즉시 발행하며 현금영수증의 상태값이 '발행완료'가 됩니다.

'발행완료' 상태의 현금영수증은 국세청 전송 정책에 따라 국세청에 전송됩니다.

Response RegistIssue(string CorpNum, Cashbill cashbill, string Memo, string UserID = null, string EmailSubject = null)

개발 유의사항
ㆍ현금영수증의 거래일자는 즉시 발행(RegistIssue) 함수로 발행한 날짜이며 수정이 불가합니다.
ㆍ현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)
ㆍ현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.
ㆍ팝빌 개발환경에서 발행한 현금영수증은 실제로 국세청에 전송되지 않고 가상으로 전송처리됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 cashbill Cashbill - O 현금영수증 객체정보
3 Memo string 200 - 발행시 남길 수 있는 메모, 상태확인(GetInfo)를 통해 stateMemo(상태메모) 확인 가능
4 UserID string 50 - 팝빌회원 아이디
5 EmailSubject string 300 - 현금영수증 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용

Return

Response

Throws

PopbillException

1.3. Register - 임시저장

ㆍ팝빌에 현금영수증을 임시저장합니다. '임시저장' 상태의 현금영수증은 국세청에 전송되지 않습니다.

Response Register(string CorpNum, Cashbill cashbill, string UserID = null)

개발 유의사항
ㆍ현금영수증 자진발급분은 소득공제 용도로만 발행 가능합니다. (자진발급 번호 : 010-000-1234)
ㆍ'임시저장' 상태의 현금영수증을 발행(Issue)하면 '발행완료' 상태가 됩니다.
ㆍ'발행완료' 상태의 현금영수증만이 국세청 전송 대상입니다. 국세청 전송 정책 보기
ㆍ임시저장(Register)과 발행(Issue)을 하나의 함수로 처리할 수 있는 즉시 발행(RegistIssue) 함수 사용을 권장합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 cashbill Cashbill - O 현금영수증 객체정보
3 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.4. Update - 수정

'임시저장' 상태인 현금영수증 기재사항을 수정합니다.

Response Update(string CorpNum, string MgtKey, Cashbill cashbill, string UserID = null)

개발 유의사항
ㆍ'임시저장' 상태가 아닌 현금영수증은 수정(Update)을 사용할 수 없습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 cashbill Cashbill - O 현금영수증 객체정보
4 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.5. Issue - 발행

ㆍ'임시저장' 상태의 현금영수증을 발행하며, 발행된 현금영수증의 상태값이 '발행완료'가 됩니다.

Response Issue(string CorpNum, string MgtKey, string Memo, string UserID = null)

개발 유의사항
ㆍ현금영수증의 거래일자는 발행(Issue) 함수로 현금영수증을 발행한 날짜이고 수정이 불가합니다.
ㆍ'임시저장' 상태가 아닌 현금영수증은 발행(Isssue)을 사용할 수 없습니다.
ㆍ'발행완료' 상태의 현금영수증은 국세청 전송 정책에 따라 국세청에 전송됩니다. 국세청 전송 정책 보기

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 Memo string 200 - 발행시 남길 수 있는 메모, 상태확인(GetInfo) stateMemo(상태메모) 확인 가능
4 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.6. CancelIssue - 발행취소

'발행완료' 상태의 현금영수증을 발행취소하며 국세청 전송 대상에서 제외됩니다.

ㆍ국세청 '전송중', '전송성공' 상태의 현금영수증은 발행취소 할 수 없습니다.

Response CancelIssue(string CorpNum, string MgtKey, string Memo, string UserID = null)

'전송성공' 상태의 현금영수증은 취소 현금영수증을 발행하여 취소 할 수 있습니다. [참고] 취소 현금영수증 발행 보기

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 Memo string 200 - 발행취소시 남길 수 있는 메모, 상태확인(GetInfo)를 통해 stateMemo(상태메모) 확인 가능
4 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.7. Delete - 삭제

'임시저장', '발행취소', '전송실패' 상태의 현금영수증을 삭제합니다.

Response Delete(string CorpNum, string MgtKey, string UserID = null)

ㆍ삭제한 현금영수증에 사용된 문서번호(mgtKey)는 재사용 할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.8. RevokeRegistIssue - 취소 현금영수증 즉시발행

ㆍ취소 현금영수증을 즉시 발행하며 발행한 취소 현금영수증의 상태값은 '발행완료' 상태가 됩니다.

ㆍ취소 현금영수증의 금액은 원본 금액을 넘을 수 없으며, 부분취소 현금영수증 작성시에는 공급가액, 부가세, 봉사료, 거래금액은 취소할 금액을 넣습니다.

Response RevokeRegistIssue(string CorpNum, string mgtKey, string orgConfirmNum, string orgTradeDate, bool smssendYN = false, string memo = null, bool isPartCancel = false, int? cancelType = null, string totalAmount = null, string supplyCost = null, string tax = null, string serviceFee = null, string UserID = null)

개발 유의사항
ㆍ원본 현금영수증의 국세청 승인번호 및 거래일자는 상태확인(GetInfo)함수를 통해 확인 가능합니다.
ㆍ취소 현금영수증 발행시 구매자 메일주소로 발행 안내 메일이 전송되니 유의하시기 바랍니다.
ㆍ팝빌 개발환경에서 발행한 현금영수증은 실제로 국세청에 전송되지 않고 가상으로 전송처리됩니다.
ㆍ'발행완료' 상태의 현금영수증은 국세청 전송 정책에 따라 국세청에 전송됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey string 24 O 파트너가 부여한 문서번호
3 orgConfirmNum string 9 O 원본 현금영수증의 국세청승인번호
4 orgTradeDate string 8 O 원본현금영수증 거래일자, 날짜형식(yyyyMMdd)
5 smssendYN bool - - 발행 안내문자 전송여부
6 memo string 200 - 발행시 남길 수 있는 메모, 상태확인(GetInfo)를 통해 stateMemo(상태메모) 확인 가능
7 isPartCancel bool - - 취소유형 [ True-부분 취소, False-전체 취소 중 택1 ]
8 cancelType int? 1 - 취소사유 [ 1-거래취소, 2-오류발급취소, 3-기타 중 택1 ]
9 totalAmount string 9 - 거래금액 (공급가액+부가세+봉사료) 입력
취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
10 supplyCost string 9 - 공급가액, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
11 tax string 9 - 부가세, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
12 serviceFee string 9 - 봉사료, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
13 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

1.9. RevokeRegister - 취소 현금영수증 임시저장

ㆍ취소 현금영수증을 임시저장할 수 있으며, '임시저장' 상태의 현금영수증은 국세청에 전송되지 않습니다.

ㆍ취소 현금영수증의 금액은 원본 금액을 넘을 수 없으며, 부분취소 현금영수증 작성시에는 공급가액, 부가세, 봉사료, 거래금액은 취소할 금액을 넣습니다.

Response RevokeRegister(string CorpNum, string mgtKey, string orgConfirmNum, string orgTradeDate, bool smssendYN = false, bool isPartCancel = false, int? cancelType = null, string totalAmount = null, string supplyCost = null, string tax = null, string serviceFee = null, string UserID = null)

개발 유의사항
ㆍ원본 현금영수증의 국세청 승인번호 및 거래일자는 상태확인(GetInfo)함수를 통해 확인 가능합니다.
ㆍ'임시저장' 상태의 현금영수증을 발행(Issue)하면 '발행완료' 상태가 됩니다.
ㆍ'발행완료' 상태의 현금영수증만이 국세청 전송 대상입니다. 국세청 전송 정책 보기

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 mgtKey string 24 O 파트너가 부여한 문서번호
3 orgConfirmNum string 9 O 원본 현금영수증의 국세청승인번호
4 orgTradeDate string 8 O 원본 현금영수증의 거래일자, 날짜형식(yyyyMMdd)
5 smssendYN bool - - 발행 안내문자 전송여부
6 isPartCancel bool - - 취소유형 [ True-부분 취소, False-전체 취소 중 택1 ]
7 cancelType int? 1 - 취소사유 [ 1-거래취소, 2-오류발급취소, 3-기타 중 택1 ]
8 totalAmount string 9 - 거래금액 (공급가액+부가세+봉사료) 입력
취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
9 supplyCost string 9 - 공급가액, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
10 tax string 9 - 부가세, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
11 serviceFee string 9 - 봉사료, 취소유형이 부분취소일 경우 취소할 금액 입력
취소유형이 전체취소일 경우 미입력
12 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

2. 현금영수증 정보확인

2.1. GetInfo - 상태 확인

ㆍ현금영수증 1건의 상태코드(stateCode)와 요약정보 확인합니다.

CashbillInfo GetInfo(string CorpNum, string MgtKey, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

CashbillInfo

Throws

PopbillException

2.2. GetInfos - 상태 대량 확인

ㆍ다수건의 현금영수증 상태코드(stateCode) 및 요약정보 확인합니다. (최대 1,000건)

List<CashbillInfo> GetInfos(string CorpNum, List<string> MgtKeyList, string UserID = null)

ㆍ현금영수증 목록을 구현하는 경우 GetInfos 함수 활용을 권장합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyList List<string> 1000 O 문서번호 배열 (최대 1,000건)
3 UserID string 50 - 팝빌회원 아이디

Return

List<CashbillInfo>

Throws

PopbillException

2.3. GetDetailInfo - 상세정보 확인

ㆍ현금영수증 1건의 상세정보 확인합니다.

Cashbill GetDetailInfo(string CorpNum, string MgtKey, string UserID = null)

ㆍ현금영수증 정보를 출력하는 화면 구현시 GetDetailInfo 함수 활용을 권장합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

Cashbill

Throws

PopbillException

2.4. Search - 목록 조회

ㆍ검색조건에 해당하는 현금영수증 목록을 조회합니다.

CBSearchResult Search(string CorpNum, string DType, string SDate, string EDate, string[] State = null, string[] TradeType = null, string[] TradeUsage = null, string[] TradeOpt = null, string[] TaxationType = null, int? Page = null, int? PerPage = null, string Order = null, string QString = null, string UserID = null)

ㆍ페이지 관련 항목(Page, PerPage, Order)을 활용하여 현금영수증 목록 페이지 기능을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 DType string 1 O 일자유형 [ R-등록일자, T-거래일자, I–발행일시 중 택1 ]
3 SDate string 8 O 시작일자, 날짜형식(yyyyMMdd)
4 EDate string 8 O 종료일자, 날짜형식(yyyyMMdd)
5 State string[] - - [배열] 상태코드, 상태코드 2,3번째 자리에 와일드카드(*) 사용가능, 예) "1**", "3**"
[부록] "현금영수증 상태코드"
6 TradeType string[] - - [배열] 문서형태 [ N-일반 현금영수증 / C-취소 현금영수증 ]
7 TradeUsage string[] - - [배열] 거래구분 [ P–소득공제용 / C-지출증빙용 ]
8 TradeOpt string[] - - [배열] 거래유형 [ N–일반 / B–도서공연 / T-대중교통 ]
9 TaxationType string[] - - [배열] 과세형태 [ T–과세 / N–비과세 ]
10 Page int? - - 페이지번호, 기본값 '1'
11 PerPage int? - - 페이지당 검색개수, 기본값 500, 최대 1000
12 Order string 1 - 정렬 방향, 기본값 'D' [ D-내림차순, A-오름차순 중 택1 ]
13 Qstring string - - 거래처 상호 또는 사업자번호 검색 조회, 공백처리시 전체조회
14 UserID string 50 - 팝빌회원 아이디

Return

CBSearchResult

Throws

PopbillException

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

ㆍ현금영수증의 상태, 등록일시, 요청 IP, 처리담당자 등의 정보에 대한 변경이력을 확인합니다.

List<CashbillLog> GetLogs(string CorpNum, string MgtKey, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

List<CashbillLog>

Throws

PopbillException

2.6. GetURL - 현금영수증 문서함 관련 URL

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

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

string GetURL(string CorpNum, string TOGO, string UserID = null)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3. 현금영수증 보기/인쇄

3.1. GetPopUpURL - 현금영수증 보기 URL

ㆍ팝빌 사이트의 현금영수증 1건의 상세 화면 페이지의 URL을 반환합니다.

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

string GetPopUpURL(string CorpNum, string MgtKey, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.2. GetPrintURL - 현금영수증 인쇄 URL

ㆍ현금영수증 1건의 인쇄를 할 수 있는 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

string GetPrintURL(string CorpNum, string MgtKey, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.3. GetMassPrintURL - 현금영수증을 대량 인쇄 URL

ㆍ현금영수증을 최대 100건 출력할 수 있는 인쇄를 할 수 있는 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

string GetMassPrintURL(string CorpNum, List<string> MgtKeyList, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyList List<string> 100 O 문서번호 배열 (최대 100건)
3 UserID string 50 - 팝빌회원 아이디

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

3.4. GetMailURL - 현금영수증 메일링크 URL

ㆍ구매자가 수신하는 현금영수증 안내 메일의 하단에 버튼 URL 주소를 반환합니다.

string GetMailURL(string CorpNum, string MgtKey, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 UserID string 50 - 팝빌회원 아이디

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

4. 부가기능

4.1. GetAccessURL - 팝빌 로그인 URL

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

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

string GetAccessURL(string CorpNum, string UserID)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

4.2. SendEmail - 메일 전송

ㆍ현금영수증 안내 메일을 재전송 합니다.

Response SendEmail(string CorpNum, string MgtKey, string Receiver, string UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 Receiver string - O 수신자 이메일주소
4 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

4.3. SendSMS - 문자 전송

ㆍSMS(단문) 문자를 전송하며 포인트가 차감 됩니다. (단, 전송실패시 환불)

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

Response SendSMS(string CorpNum, string MgtKey, string Sender, string Receiver, string Contents, string UserID = null)

ㆍ팝빌 사이트의 [문자 팩스] > [문자] > [전송내역] 페이지에서 전송결과를 확인할 수 있습니다.
ㆍ팝빌 사이트의 [문자 팩스] > [문자] > [문자전송] 페이지에서 SMS 입력란을 통해 메시지 길이를 알 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 Sender string - O 발신번호
4 Receiver string - O 수신번호
5 Contents string 90 O 문자메시지 내용, 최대 90Byte 초과된 내용은 삭제되어 전송됨
6 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

4.4. SendFAX - 팩스 전송

ㆍ현금영수증을 팩스 전송하며 포인트가 차감됩니다. (단, 전송실패 환불 / 특정 사유 제외)

Response SendFAX(string CorpNum, string MgtKey, string Sender, string Receiver, string UserID = null)

개발 유의사항
ㆍ팝빌 사이트 > [문자 팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
ㆍ팩스와 수신단말기 간에 통신이 연결된 경우 전송 실패가 되더라도 환불이 불가합니다. (예, 수신자가 수화기를 들거나 수신단말기에서 ARS 음성이 감지된 경우)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKey string 24 O 파트너가 부여한 문서번호
3 Sender string - O 발신번호
4 Receiver string - O 수신번호
5 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

4.5. ListEmailConfig - 현금영수증 알림메일 전송목록 조회

ㆍ현금영수증 관련 메일전송 항목에 대한 전송여부를 목록을 반환합니다.

List<EmailConfig> ListEmailConfig(string CorpNum, string UserID = null)

Parameters

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

Return

List<EmailConfig>

Throws

PopbillException

4.6. UpdateEmailConfig - 현금영수증 알림메일 전송설정 수정

ㆍ현금영수증 관련 메일전송 항목에 대한 전송여부를 수정합니다.

Response UpdateEmailConfig(string CorpNum, string EmailType, bool SendYN, string UserID = null)

Parameters

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

CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일
CSH_CANCEL : 고객에게 현금영수증이 발행취소 되었음을 알려주는 메일

3 SendYN bool - O 전송 여부
4 UserID string 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5. 포인트 관리

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

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

Double GetBalance(string CorpNum)

Parameters

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

Return

Double - 연동회원 잔여포인트

Throws

PopbillException

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

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

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

string GetChargeURL(string CorpNum, string UserID)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

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

Double GetPartnerBalance(string CorpNum)

Parameters

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

Return

Double - 파트너 잔여포인트

Throws

PopbillException

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

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

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

string GetPartnerURL(string CorpNum, string TOGO)

Parameters

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

Return

string - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetUnitCost - 발행 단가 확인

ㆍ현금영수증 발행시 과금되는 포인트 단가를 확인합니다.

Single GetUnitCost(string CorpNum, string UserID = null)

Parameters

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

Return

Single - 현금영수증 발행단가

Throws

PopbillException

5.6. GetChargeInfo - 과금정보 확인

ㆍ팝빌 현금영수증 API 서비스 과금정보를 확인합니다.

ChargeInfo GetChargeInfo(string CorpNum, string UserID = null)

Parameters

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

Return

ChargeInfo

Throws

PopbillException

6. 회원정보

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

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

Response CheckIsMember(string CorpNum, string LinkID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID string - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

Response

Throws

PopbillException

6.2. CheckID - 아이디 중복 확인

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

Response CheckID(string ID)

Parameters

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

Return

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

Throws

PopbillException

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

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

Response JoinMember(JoinForm joinInfo)

Parameters

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

Return

Response

Throws

PopbillException

6.4. GetCorpInfo - 회사정보 확인

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

CorpInfo GetCorpInfo(string CorpNum, string UserID = null)

Parameters

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

Return

CorpInfo

Throws

PopbillException

6.5. UpdateCorpInfo - 회사정보 수정

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

Response UpdateCorpInfo(string CorpNum, CorpInfo corpInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

6.6. RegistContact - 담당자 추가

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

Response RegistContact(string CorpNum, Contact contactInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

6.7. ListContact - 담당자 목록 확인

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

List<Contact> ListContact(string CorpNum, string UserID = null)

Parameters

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

Return

List<Contact>

Throws

PopbillException

6.8. UpdateContact - 담당자 정보 수정

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

Response UpdateContact(string CorpNum, Contact contactInfo, string UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

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

A.3. Cashbill

순번 변수명 항목명 타입 길이 필수 비고
1 mgtKey 문서번호 string 24 O 파트너가 부여한 현금영수증 문서번호 기재
2 confirmNum 국세청승인번호 string 9 - 국세청 전송시 팝빌이 부여하는 현금영수증 국세청승인번호
3 orgConfirmNum 원본 현금영수증 국세청승인번호 string 9 - 문서형태 "취소거래" 경우 필수 기재
4 orgTradeDate 원본 현금영수증 거래일자 string 8 - 문서형태 "취소거래" 경우 필수 기재
5 tradeDate 거래일자 string 8 - 즉시 발행(RegistIssue) 또는 발행(Issue) 함수로 현금영수증을 발행한 날짜
팝빌이 자동으로 부여하는 값 (예 20191211)
6 tradeType 문서형태 string 4 O "승인거래", "취소거래" 중 기재
7 tradeUsage 거래구분 string - O "소득공제용, "지출증빙용" 중 기재
8 tradeOpt 거래유형 string 4 - "일반", "도서공연", "대중교통" 중 기재
9 taxationType 과세형태 string - O "과세", "비과세" 중 기재
10 totalAmount 거래금액 string 9 O 숫자만 가능
11 supplyCost 공급가액 string 9 O 숫자만 가능
12 tax 부가세 string 9 O 숫자만 가능
13 serviceFee 봉사료 string 9 O 숫자만 가능
14 franchiseCorpNum 가맹점 사업자번호 string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
15 franchiseCorpName 가맹점 상호 string 200 -
16 franchiseCEOName 가맹점 대표자 성명 string 100 -
17 franchiseAddr 가맹점 주소 string 400 -
18 franchiseTEL 가맹점 전화번호 string 20 -
19 identityNum 식별번호 string 19 O

거래유형을 소득공제용으로 기재한 경우
- 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 기재

거래유형을 지출증빙용으로 기재한 경우
- 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 기재

20 customerName 주문자명 string 70 -
21 itemName 주문상품명 string 70 -
22 orderNumber 주문번호 string 200 -
23 email 이메일 string 100 -
24 hp 휴대폰 string 20 -
25 smssendYN SMS 전송여부 bool? - -
26 faxsendYN FAX 전송여부 bool? - -
27 cancelType 취소사유 int 1 - 취소사유 [ 1-거래취소, 2-오류발급취소, 3-기타 중 택1 ]

A.4. CBSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 int -
2 message 요청에 대한 응답메시지 string -
3 total 총 검색결과 건수 int -
4 perPage 페이지당 검색개수 int -
5 pageNum 페이지 번호 int -
6 pageCount 페이지 개수 int -
7 list 현금영수증 상태/요약정보 List<CashbillInfo> [리스트] 최대 1,000개, 상태 확인(GetInfo) 응답전문의 구성과 동일

A.5. CashbillInfo

순번 변수명 항목명 타입 길이 비고
1 itemKey 팝빌번호 string 18 팝빌이 부여한 식별번호
2 mgtKey 문서번호 string 24 파트너가 부여한 문서번호
3 tradeDate 거래일자 string 8 날짜형식(yyyyMMdd)
4 tradeType 문서형태 string 4 승인거래, 취소거래 중 반환
5 tradeUsage 거래구분 string 5 소득공제용, 지출증빙용 중 반환
6 tradeOpt 거래유형 string 4 일반, 도서공연, 대중교통 중 반환
7 taxationType 과세형태 string 3 과세, 비과세 중 반환
8 totalAmount 거래금액 string 9
9 issueDT 발행일시 string 14 날짜형식(yyyyMMddHHmmss)
10 regDT 등록일시 string 14 날짜형식(yyyyMMddHHmmss)
11 stateMemo 상태메모 string 200
12 stateCode 상태코드 int 3 [부록] "현금영수증 상태코드"
13 stateDT 상태변경일시 string 14 날짜형식(yyyyMMddHHmmss)
14 identityNum 식별번호 string 19

거래유형을 소득공제용으로 기재한 경우
- 주민등록/휴대폰/카드번호(현금영수증 카드)/자진발급용 번호(010-000-1234) 기재

거래유형을 지출증빙용으로 기재한 경우
- 사업자번호/주민등록/휴대폰/카드번호(현금영수증 카드) 기재

15 itemName 주문상품명 string 70
16 customerName 주문자명 string 70
17 confirmNum 국세청승인번호 string 9 국세청 전송시 팝빌이 부여한 현금영수증 국세청승인번호
18 orgConfirmNum 원본 현금영수증
국세청승인번호
string 9
19 orgTradeDate 원본 현금영수증 거래일자 string 8
20 ntssendDT 국세청 전송일시 string 14 날짜형식(yyyyMMddHHmmss)
21 ntsresultDT 국세청 처리결과 수신일시 string 14 날짜형식(yyyyMMddHHmmss)
22 ntsresultCode 국세청 처리결과 상태코드 string 4 [부록] "국세청 처리결과 상태코드"
23 ntsresultMessage 국세청 처리결과 메시지 string 30
24 printYN 인쇄여부 bool? -

A.6. CashbillLog

순번 변수명 항목명 타입 길이 비고
1 docLogType 로그타입 int 3 100-임시저장 / 101-수정 / 111-메일 재전송 / 112- 문자 재전송 / 113-팩스 재전송
122-문자 전송결과 / 123-팩스 전송결과
410-발행 / 411-발행취소 / 451-전송 대기전
452-전송 진행중 / 453-국세청 전송 접수
454-전송완료 / 455-전송실패
2 log 이력정보 string 2000
3 procType 처리형태 string 3 연동 - API / 일반 - 팝빌 사이트 / 시스템 - 팝빌 시스템
4 procMemo 처리메모 string 200
5 regDT 등록일시 string 14
6 ip 아이피 string 39

A.7. EmailConfig

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

CSH_ISSUE : 고객에게 현금영수증이 발행 되었음을 알려주는 메일
CSH_CANCEL : 고객에게 현금영수증이 발행취소 되었음을 알려주는 메일

2 sendYN 전송여부 bool? - True-전송 / False-미전송

A.8. ChargeInfo

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

A.9. 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.10. 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.11. Contact

순번 변수명 항목명 타입 길이 필수 비고
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 담당자 조회권한 설정 bool? - O

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

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

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