2. 현금영수증 정보확인

2.1. GetInfo - 상태 확인

현금영수증 1건의 상태 및 요약정보를 확인합니다.
리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.

def getInfo(CorpNum, MgtKey):

Parameters

순번	변수명	타입	길이	필수	설명
	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
	MgtKey	str	24	Y	파트너가 할당한 문서번호

Return

CashbillInfo

Throws

PopbillException

2.2. GetInfos - 다수건 상태 확인

다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.

def getInfos(CorpNum, MgtKeyList):

문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.

Parameters

순번	변수명	타입	길이	필수	설명
	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
	MgtKeyList	list		Y	조회할 현금영수증 문서번호 최대 : 1,000건

Return

CashbillInfo[ ]

Throws

PopbillException

2.3. GetDetailInfo - 상세정보 확인

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

def getDetailInfo(CorpNum, MgtKey):

Parameters

순번	변수명	타입	길이	필수	설명
	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
	MgtKey	str	24	Y	파트너가 할당한 문서번호

Return

Cashbill

Throws

PopbillException

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

파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.
이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.

def checkMgtKeyInUse(CorpNum, MgtKey):

Parameters

순번	변수명	타입	길이	필수	설명
	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
	MgtKey	str	24	Y	확인할 문서번호

Return

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

Throws

PopbillException

2.5. Search - 목록 조회

검색조건에 해당하는 현금영수증을 조회합니다. (최대 조회기간 : 6개월)

def search(CorpNum, DType, SDate, EDate, State, TradeType, TradeUsage, TaxationType, Page, PerPage, Order, UserID=None, Qstr=None, TradeOpt=None, FranchiseTaxRegID=None):

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

Parameters

변수명	타입	길이	필수	설명
CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
DType	str	1	Y	조회 기준일자 유형 (택 1) R등록일자 T거래일자 I발행일시
SDate	str	8	Y	조회 기간의 시작일자 형식 : yyyyMMdd
EDate	str	8	Y	조회 기간의 종료일자 형식 : yyyyMMdd
State	list		N	현금영수증 상태코드 2, 3번째 자리에 와일드카드() 사용가능. 예) "3*" [참고] 팝빌 상태코드 기본값 : 전체조회
TradeType	list		N	현금영수증 문서형태 (다중 선택 가능) N승인 현금영수증 C취소 현금영수증 기본값 : 전체조회
TradeUsage	list		N	거래구분 (다중 선택 가능) P소득공제용 C지출증빙용 기본값 : 전체조회
TaxationType	list		N	과세형태 (다중 선택 가능) T과세 N비과세 기본값 : 전체조회
Page	int	-	N	목록 페이지번호 기본값 : 1
PerPage	int	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
Order	str	1	N	조회 기준일자 유형을 기준으로 하는 목록 정렬 방향 D내림차순 : 기본값 A오름차순
UserID	str	50	N	팝빌회원 아이디
Qstr	str	-	N	조회 검색어(식별번호) 기본값 : 전체조회
TradeOpt	list		N	거래유형 (다중 선택 가능) N일반 B도서공연 T대중교통 기본값 : 전체조회
FranchiseTaxRegID	str	-	N	가맹점 종사업장번호 다수건 검색시 콤마(',')로 구분. 예) 1234,1000 기본값 : 전체조회

Return

CBSearchResult

Throws

PopbillException

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

로그인 상태로 팝빌 사이트의 현금영수증 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getURL(CorpNum, UserID, ToGo):

Parameters

변수명	타입	길이	필수	설명
CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
UserID	str	50	N	팝빌회원 아이디
ToGo	str	-	Y	접근 메뉴 (택 1) TBOX임시 문서함 PBOX발행 문서함 WRITE현금영수증 작성

Return

str - 요청에 대한 응답 URL

Throws

PopbillException