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