2. 전자명세서 정보확인
2.1. GetInfo - 상태 확인
- 전자명세서의 1건의 상태 및 요약정보 확인합니다.
StatementInfo getInfo(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| ItemCode | int | 3 | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
|
| MgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
Return
Throws
2.2. GetInfos - 다수건 상태 확인
- 다수건의 전자명세서 상태 및 요약정보 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
StatementInfo[] getInfos(String CorpNum, int ItemCode, String[] MgtKeyList) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| ItemCode | int | 3 | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
|
| MgtKeyList | String[ ] | O | 조회할 전자명세서 문서번호 (최대 1,000건) | ||
Return
Throws
2.3. GetDetailInfo - 상세정보 확인
- 전자명세서 1건의 상세정보 확인합니다.
Statement getDetailInfo(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| ItemCode | int | 3 | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
|
| MgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
Return
Throws
2.4. CheckMgtKeyInUse - 문서번호 사용 여부 확인
- 파트너가 전자명세서 관리 목적으로 할당하는 문서번호의 사용여부를 확인합니다.
- 이미 사용 중인 문서번호는 중복 사용이 불가하고, 전자명세서가 삭제된 경우에만 문서번호의 재사용이 가능합니다.
Boolean checkMgtKeyInUse(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| ItemCode | int | 3 | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
|
| MgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
Return
boolean - true : (사용중) / false : (미사용중)
Throws
2.5. Search - 목록 조회
- 검색조건에 해당하는 전자명세서를 조회합니다. (최대 조회기간 : 6개월)
StmtSearchResult search(String CorpNum, String DType, String SDate, String EDate, String[] State, int[] ItemCode, String QString, int Page, int PerPage, String Order) throws PopbillException- 페이지 관련 항목(Page, PerPage, Order)을 활용하여 전자명세서 목록을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| DType | String | 1 | O |
조회 기준일자 유형 : "R" / "W" / "I" 중 택 1
└ R = 등록일자, W = 작성일자, I = 발행일자 |
|
| SDate | String | 8 | O | 조회 기간의 시작일자 (형식 : yyyyMMdd) | |
| EDate | String | 8 | O | 조회 기간의 종료일자 (형식 : yyyyMMdd) | |
| State | String[ ] | - |
전자명세서 상태코드
└ 2,3번째 자리에 와일드카드(*) 사용가능, 예) "1**", "3**" [참고] 전자명세서 상태코드 ※ 미입력시 전체조회 |
||
| ItemCode | int[ ] | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 선택 (다중 선택 가능)
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
||
| QString | String | - | - |
거래처 상호 / 사업자번호 중 검색하고자 하는 정보 입력
※ 미입력시 전체조회 |
|
| Page | int | - | O | 목록 페이지번호 | |
| PerPage | int | - | O | 페이지당 표시할 목록 개수 (최대 1,000) | |
| Order | String | 1 | - |
{DType} 값을 기준으로 하는 목록 정렬 방향
└ "D" : 내림차순(기본값) └ "A" : 오름차순 |
|
Return
Throws
2.6. GetLogs - 전자명세서 상태 변경이력 확인
- 전자명세서의 상태에 대한 변경이력을 확인합니다.
StatementLog[] getLogs(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| ItemCode | int | 3 | O |
전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증 |
|
| MgtKey | String | 24 | O | 파트너가 할당한 문서번호 |
Return
Throws
2.7. GetURL - 팝빌 전자명세서 문서함 팝업 URL
- 로그인 상태로 팝빌 사이트의 전자명세서 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String getURL(String CorpNum, String UserID, String TOGO) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | O | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
| UserID | String | 50 | - | 팝빌회원 아이디 | |
| TOGO | String | - | O |
접근 메뉴 : "TBOX" / "SBOX" 중 택 1
└ TBOX = 임시 문서함, / SBOX = 매출 문서함 |
Return
String - 요청에 대한 응답 URL