A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 |
IssueResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| confirmNum | str | 9 |
국세청승인번호
현금영수증 발행 시점에 팝빌에서 자동으로 할당
|
|
| tradeDate | str | 8 |
거래일자
현금영수증 발행 시점에 팝빌에서 자동으로 할당
형식 : yyyyMMdd |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| message | str | - | API 처리 실패에 대한 오류메시지 |
Cashbill - 입력부
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| mgtKey | str | 24 | Y |
문서번호
문서 관리를 위해 파트너가 할당하는 식별번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|
| orgConfirmNum | str | 9 | 조건부 |
당초 국세청승인번호
취소 현금영수증 작성시 필수
|
|
| orgTradeDate | str | 9 | 조건부 |
당초 거래일자
취소 현금영수증 작성시 필수
|
|
| tradeDT | str | 14 | N |
거래일시
전일부터 당일까지 입력 가능
형식 : yyyyMMddHHmmss 기본값 : 발행일시 사용
|
|
| tradeType | str | 4 | Y |
문서형태 (택 1)
승인거래
취소거래
|
|
| tradeUsage | str | 5 | Y |
거래구분 (택 1)
소득공제용
지출증빙용
|
|
| tradeOpt | str | 4 | N |
거래유형
일반 : 기본값
도서공연
대중교통
|
|
| taxationType | str | 3 | Y |
과세형태 (택 1)
과세
비과세
|
|
| totalAmount | str | 9 | Y |
거래금액
양수만 입력
|
|
| supplyCost | str | 9 | Y |
공급가액
양수만 입력
|
|
| tax | str | 9 | Y |
부가세
양수 또는 0 입력
|
|
| serviceFee | str | 9 | Y |
봉사료
양수 또는 0 입력
|
|
| franchiseCorpNum | str | 10 | Y |
가맹점 사업자번호
팝빌회원 사업자번호 ('-' 제외)
|
|
| franchiseTaxRegID | str | 4 | N |
가맹점 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| franchiseCorpName | str | 200 | N | 가맹점 상호 | |
| franchiseCEOName | str | 100 | N | 가맹점 대표자 성명 | |
| franchiseAddr | str | 400 | N | 가맹점 주소 | |
| franchiseTEL | str | 20 | N | 가맹점 전화번호 | |
| identityNum | str | 19 | Y |
식별번호
- {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 입력 - {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 입력 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
|
|
| customerName | str | 70 | N | 구매자(고객) 성명 | |
| itemName | str | 70 | N | 주문 상품명 | |
| orderNumber | str | 200 | N | 주문번호 | |
| str | 100 | N | 구매자(고객) 이메일 | ||
| hp | str | 20 | N | 구매자(고객) 휴대폰 | |
| smssendYN | bool | - | N |
구매자 알림문자 전송 여부
True전송
False미전송 : 기본값
수신자 : 구매자 휴대폰번호 {hp}
문자 전송 포인트가 차감(단, 전송실패 건은 환불) |
|
| cancelType | int | 1 | N |
취소사유
1거래취소 : 기본값
2오류발급취소
3기타
|
|
| memo | str | 200 | N |
현금영수증 상태 이력을 관리하기 위한 메모
대량(Bulk)발행 경우 사용
|
|
| emailSubject | str | 300 | N |
현금영수증 발행 안내메일 제목
기본값 : 팝빌에서 설정한 안내메일 제목
|
Cashbill - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| mgtKey | str | 24 |
문서번호
문서 관리를 위해 파트너가 할당하는 식별번호
|
|
| confirmNum | str | 9 |
국세청승인번호
현금영수증 발행 시점에 팝빌에서 자동으로 할당
|
|
| orgConfirmNum | str | 9 | 당초 국세청승인번호 | |
| orgTradeDate | str | 9 | 당초 거래일자 | |
| tradeDate | str | 8 |
거래일자
현금영수증 발행 시점에 팝빌에서 자동으로 할당
{tradeDT}의 yyyyMMdd |
|
| tradeDT | str | 14 |
거래일시
형식 : yyyyMMddHHmmss
|
|
| tradeType | str | 4 |
문서형태
승인거래
취소거래
|
|
| tradeUsage | str | 5 |
거래구분
소득공제용
지출증빙용
|
|
| tradeOpt | str | 4 |
거래유형
일반
도서공연
대중교통
|
|
| taxationType | str | 3 |
과세형태
과세
비과세
|
|
| totalAmount | str | 9 | 거래금액 | |
| supplyCost | str | 9 | 공급가액 | |
| tax | str | 9 | 부가세 | |
| serviceFee | str | 9 | 봉사료 | |
| franchiseCorpNum | str | 10 |
가맹점 사업자번호
팝빌회원 사업자번호 ('-' 제외)
|
|
| franchiseTaxRegID | str | 4 |
가맹점 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|
| franchiseCorpName | str | 200 | 가맹점 상호 | |
| franchiseCEOName | str | 100 | 가맹점 대표자 성명 | |
| franchiseAddr | str | 400 | 가맹점 주소 | |
| franchiseTEL | str | 20 | 가맹점 전화번호 | |
| identityNum | str | 19 |
식별번호
- {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 - {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환 |
|
| customerName | str | 70 | 구매자(고객) 성명 | |
| itemName | str | 70 | 주문 상품명 | |
| orderNumber | str | 200 | 주문번호 | |
| str | 100 | 구매자(고객) 이메일 | ||
| hp | str | 20 | 구매자(고객) 휴대폰 | |
| smssendYN | bool | - |
구매자 알림문자 전송 여부
True전송
False미전송 : 기본값
수신자 : 구매자 휴대폰번호 {hp}
|
|
| cancelType | int | 1 |
취소사유
1거래취소
2오류발급취소
3기타
|
BulkResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| receiptID | str | 36 |
접수아이디
접수 시점에 팝빌에서 자동으로 할당
|
BulkCashbillResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| submitID | str | 36 | 접수 시점에 고객사에서 할당한 제출아이디 | |
| submitCount | int | - | 현금영수증 접수 건수 | |
| successCount | int | - | 현금영수증 발행 성공 건수 | |
| failCount | int | - | 현금영수증 발행 실패 건수 | |
| txState | int | 1 |
접수상태
0접수
1처리중
2처리완료
|
|
| txResultCode | int | - |
접수 결과코드
- 성공 : 1 - 실패 : 음의 정수 8자리 숫자값 [참고] 오류코드 |
|
| txStartDT | str | 14 |
발행처리 시작일시
형식 : yyyyMMddHHmmss
|
|
| txEndDT | str | 14 |
발행처리 완료일시
형식 : yyyyMMddHHmmss
|
|
| receiptDT | str | 14 |
접수일시
형식 : yyyyMMddHHmmss
|
|
| issueResult | BulkCashbillIssueResult[ ] | 발행결과 | ||
| receiptID | str | 36 |
접수아이디
접수 시점에 팝빌에서 자동으로 할당
|
|
BulkCashbillIssueResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| mgtKey | str | 24 | 문서번호 | |
| confirmNum | str | 9 |
국세청승인번호
현금영수증 발행 시점에 팝빌에서 자동으로 할당
|
|
| tradeDate | str | 8 |
거래일자
현금영수증 발행 시점에 팝빌에서 자동으로 할당
형식 : yyyyMMdd |
|
| issueDT | str | 14 |
발행일시
형식 : yyyyMMddHHmmss
|
CBSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| total | int | - | 총 검색결과 건수 | |
| perPage | int | - | 페이지당 목록 건수 | |
| pageNum | int | - | 페이지 번호 | |
| pageCount | int | - | 페이지 개수 | |
| list | CashbillInfo[ ] |
현금영수증 상태/요약정보
함수 [GetInfo - 상태 확인]의 리턴값 구성과 동일
최대 1,000건 |
||
CashbillInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| itemKey | str | 18 | 팝빌에서 현금영수증 관리 목적으로 할당한 식별번호 | |
| mgtKey | str | 24 |
문서번호
파트너가 할당하는 식별번호
|
|
| tradeDate | str | 8 |
거래일자
형식 : yyyyMMdd
|
|
| tradeDT | str | 14 |
거래일시
형식 : yyyyMMddHHmmss
|
|
| tradeType | str | 4 |
문서형태
승인거래
취소거래
|
|
| tradeUsage | str | 5 |
거래구분
소득공제용
지출증빙용
|
|
| tradeOpt | str | 4 |
거래유형
일반
도서공연
대중교통
|
|
| taxationType | str | 3 |
과세형태
과세
비과세
|
|
| totalAmount | str | 9 | 거래금액 | |
| issueDT | str | 14 |
발행일시
형식 : yyyyMMddHHmmss
|
|
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| stateCode | int | 3 | 상태코드 | |
| stateDT | str | 14 |
상태 변경일시
형식 : yyyyMMddHHmmss
|
|
| identityNum | str | 19 |
식별번호
- {tradeUsage} 값이 "소득공제용" 경우 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 반환 - {tradeUsage} 값이 "지출증빙용" 경우 사업자번호/휴대폰/카드번호 반환 |
|
| itemName | str | 70 | 주문상품명 | |
| customerName | str | 70 | 구매자(고객) 성명 | |
| confirmNum | str | 9 |
국세청승인번호
현금영수증 발행 시점에 팝빌에서 자동으로 할당
|
|
| orgConfirmNum | str | 9 | 당초 국세청승인번호 | |
| orgTradeDate | str | 8 | 당초 거래일자 | |
| ntssendDT | str | 14 |
국세청 전송일시
형식 : yyyyMMddHHmmss
|
|
| ntsresultDT | str | 14 |
국세청 처리결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| ntsresultCode | str | 4 | 결과코드 | |
| ntsresultMessage | str | 30 | 결과메시지 | |
| printYN | bool | - |
인쇄여부
True인쇄
False미인쇄
|
|
| interOPYN | bool | - |
연동문서 여부
TrueAPI를 통해 발행한 연동문서
False팝빌 사이트를 통해 발행한 문서
|
EmailSendConfig
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| emailType | str | 9 |
메일전송유형
CSH_ISSUE
고객에게 현금영수증이 발행 되었음을 알려주는 메일 |
|
| sendYN | bool | - |
전송여부
True전송
False미전송
|