2. 현금영수증 정보확인
2.1. GetInfo - 상태 확인
- 현금영수증 1건의 상태 및 요약정보를 확인합니다.
- 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
CashbillInfo GetInfo(string CorpNum, string MgtKey, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.2. GetInfos - 다수건 상태 확인
- 다수건의 현금영수증 상태 및 요약 정보를 확인합니다. (1회 호출에 최대 1,000건 확인 가능)
- 리턴값 CashbillInfo 의 변수 'stateCode'를 통해 현금영수증의 상태코드를 확인합니다.
List<CashbillInfo> GetInfos(string CorpNum, List<string> MgtKeyList, string UserID = null)- 문서번호를 통해 현금영수증 목록을 구현하는 경우 활용합니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| MgtKeyList | List<string> | Y |
문서번호 목록
최대 : 1,000건
|
||
| UserID | string | 50 | N | 팝빌회원 아이디 | |
Return
Throws
2.3. GetDetailInfo - 상세정보 확인
- 현금영수증 1건의 상세정보를 확인합니다.
Cashbill GetDetailInfo(string CorpNum, string MgtKey, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.4. CheckMgtKeyInUse - 문서번호 사용 여부 확인
- 파트너가 현금영수증 관리 목적으로 할당하는 문서번호 사용여부를 확인합니다.
- 이미 사용 중인 문서번호는 중복 사용이 불가하고, 현금영수증이 삭제된 경우에만 문서번호의 재사용이 가능합니다.
bool CheckMgtKeyInUse(string CorpNum, string MgtKey, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| MgtKey | string | 24 | Y | 확인할 문서번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
bool - true : (사용중) / false : (미사용중)
Throws
2.5. Search - 목록 조회
- 검색조건에 해당하는 현금영수증을 조회합니다. (최대 조회기간 : 6개월)
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, string FranchiseTaxRegID = null)- 매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| DType | string | 1 | Y |
검색일자 유형 (택 1)
R등록일자
T거래일자
I발행일시
|
|
| SDate | string | 8 | Y |
검색 시작일자
형식 : yyyyMMdd
|
|
| EDate | string | 8 | Y |
검색 종료일자
형식 : yyyyMMdd
|
|
| State | string[ ] | N |
현금영수증 상태코드
2, 3번째 자리에 와일드카드(*) 사용가능. 예) "3**"
[참고] 팝빌 상태코드
기본값 : 전체조회
|
||
| TradeType | string[ ] | N |
현금영수증 문서형태 (다중 선택 가능)
N승인 현금영수증
C취소 현금영수증
기본값 : 전체조회
|
||
| TradeUsage | string[ ] | N |
거래구분 (다중 선택 가능)
P소득공제용
C지출증빙용
기본값 : 전체조회
|
||
| TradeOpt | string[ ] | N |
거래유형 (다중 선택 가능)
N일반
B도서공연
T대중교통
기본값 : 전체조회
|
||
| TaxationType | string[ ] | N |
과세형태 (다중 선택 가능)
T과세
N비과세
기본값 : 전체조회
|
||
| Page | int? | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | int? | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| Order | string | 1 | N |
조회 기준일자 유형을 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| Qstring | string | - | N |
조회 검색어(식별번호)
기본값 : 전체조회
|
|
| UserID | string | 50 | N | 팝빌회원 아이디 | |
| FranchiseTaxRegID | string | - | N |
가맹점 종사업장번호
다수건 검색시 콤마(',')로 구분. 예) 1234,1000
기본값 : 전체조회
|
|
Return
Throws
2.6. GetURL - 현금영수증 문서함 팝업 URL
- 현금영수증 문서함의 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,280px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL은 팝빌회원의 로그인 세션을 포함하고 있으니 사용에 유의하여 주시기 바랍니다.
string GetURL(string CorpNum, string TOGO, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| TOGO | string | - | Y |
접근 메뉴 (택 1)
TBOX임시 문서함
PBOX발행 문서함
WRITE현금영수증 작성
|
|
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
string - 요청에 대한 응답 URL