2. 현금영수증 정보확인
2.1. GetInfo - 상태 확인
- 현금영수증 1건의 상태 및 요약정보를 확인합니다.
- 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
def getInfo(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.2. GetInfos - 다수건 상태 확인
- 다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
- 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
def getInfos(corpNum, mgtKeyList, userID = '')
- 문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
mgtKeyList | Array | Y | 조회할 현금영수증 문서번호 (최대 1,000건) | ||
userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.3. GetDetailInfo - 상세정보 확인
- 현금영수증 1건의 상세정보를 확인합니다.
def getDetailInfo(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
mgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.4. CheckMgtKeyInUse - 문서번호 사용 여부 확인
- 파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.
- 이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.
def checkMgtKeyInUse(corpNum, mgtKey, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
mgtKey | String | 24 | Y | 확인할 문서번호 | |
userID | String | 50 | N | 팝빌회원 아이디 |
Return
Boolean - true : (사용중) / false : (미사용중)
Throws
2.5. Search - 목록 조회
- 검색조건에 해당하는 현금영수증을 조회합니다. (최대 조회기간 : 6개월)
def search(corpNum, dType, sDate, eDate, state, tradeType, tradeUsage, taxationType, page, perPage, order, queryString = '', userID = '', tradeOpt = '', franchiseTaxRegID = '')
- 페이지 관련 항목(Page, PerPage, Order)을 활용하여 현금영수증 목록 페이지 기능을 구현할 수 있습니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
dType | String | 1 | Y |
조회 기준일자 유형 : "R" / "T" / "I" 중 택 1
└ "R" : 등록일자 └ "T" : 거래일자 └ "I" : 발행일시 |
|
sDate | String | 8 | Y | 조회 기간의 시작일자 (형식 : yyyyMMdd) | |
eDate | String | 8 | Y | 조회 기간의 종료일자 (형식 : yyyyMMdd) | |
state | Array | Y |
현금영수증 상태코드
└ 상태코드 2,3번째 자리에 와일드카드(*) 사용가능, 예) "3**" | ||
tradeType | Array | Y |
현금영수증 문서형태 : "N" / "C" 중 선택 (다중 선택 가능)
└ "N" : 일반 현금영수증 └ "C" : 취소 현금영수증 |
||
tradeUsage | Array | Y |
거래구분 : "P" / "C" 중 선택 (다중 선택 가능)
└ "P" : 소득공제용 └ "C" : 지출증빙용 |
||
taxationType | Array | Y |
과세형태 : "T" / "N" 중 선택 (다중 선택 가능)
└ "T" : 과세 └ "N" : 비과세 |
||
page | Integer | - | Y | 목록 페이지번호 (기본값 1) | |
perPage | Integer | - | Y | 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) | |
order | String | 1 | Y |
{dtype} 값을 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ "D" : 내림차순(기본값) └ "A" : 오름차순 |
|
queryString | String | - | N |
현금영수증 식별번호 조회
※ 미입력시 전체조회 |
|
userID | String | 50 | N | 팝빌회원 아이디 | |
tradeOpt | Array | N |
거래유형 : "N" / "B" / "T" 중 선택 (다중 선택 가능)
└ "N" : 일반 └ "B" : 도서공연 └ "T" : 대중교통 |
||
franchiseTaxRegID | String | - | N |
가맹점 종사업장번호
└ 다수건 검색시 콤마(",")로 구분. 예) 1234,1000 ※ 미입력시 전체조회 |
Return
Throws
2.6. GetURL - 팝빌 현금영수증 문서함 관련 URL
- 로그인 상태로 팝빌 사이트의 현금영수증 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getURL(corpNum, togo, userID = '')
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
corpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
togo | String | - | Y |
접근 메뉴 : "TBOX" / "PBOX" / "WRITE" 중 택 1
└ "TBOX" : 임시 문서함 └ "PBOX" : 발행 문서함 └ "WRITE" : 현금영수증 작성 |
|
userID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL