POPBill Developers
API Reference

2. 현금영수증 정보확인

2.1. GetInfo - 상태 확인

  • 현금영수증 1건의 상태 및 요약정보를 확인합니다.
  • 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
def getInfo(corpNum, mgtKey, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
mgtKey String 24 Y 파트너가 할당한 문서번호
userID String 50 N 팝빌회원 아이디
Return

CashbillInfo

Throws

PopbillException

2.2. GetInfos - 다수건 상태 확인

  • 다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
  • 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
def getInfos(corpNum, mgtKeyList, userID = '')
  • 문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
mgtKeyList Array Y 조회할 현금영수증 문서번호
최대 : 1,000건
userID String 50 N 팝빌회원 아이디
Return

CashbillInfo[ ]

Throws

PopbillException

2.3. GetDetailInfo - 상세정보 확인

  • 현금영수증 1건의 상세정보를 확인합니다.
def getDetailInfo(corpNum, mgtKey, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
mgtKey String 24 Y 파트너가 할당한 문서번호
userID String 50 N 팝빌회원 아이디
Return

Cashbill

Throws

PopbillException

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

  • 파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.
  • 이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.
def checkMgtKeyInUse(corpNum, mgtKey, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
mgtKey String 24 Y 확인할 문서번호
userID String 50 N 팝빌회원 아이디
Return

Boolean - true : (사용중) / false : (미사용중)

Throws

PopbillException

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

  • 로그인 상태로 팝빌 사이트의 현금영수증 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getURL(corpNum, togo, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
togo String - Y 접근 메뉴 (택 1)
TBOX임시 문서함
PBOX발행 문서함
WRITE현금영수증 작성
userID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException