2. 세금계산서 정보확인
2.1. GetInfo - 상태 확인
- 세금계산서 1건의 상태 및 요약정보를 확인합니다.
- 리턴값 TaxinvoiceInfo 의 변수 'stateCode'를 통해 세금계산서의 상태코드를 확인합니다. [참고] 팝빌 상태코드
TaxinvoiceInfo getInfo(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
Return
Throws
2.2. GetInfos - 다수건 상태 확인
- 다수건의 세금계산서 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)
- 리턴값 TaxinvoiceInfo 의 변수 'stateCode'를 통해 세금계산서의 상태코드를 확인합니다. [참고] 팝빌 상태코드
TaxinvoiceInfo[] getInfos(String CorpNum, MgtKeyType KeyType, String[] MgtKeyList) throws PopbillException
- 문서번호를 통해 세금계산서 목록을 구현하는 경우 활용합니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKeyList | String[ ] | Y | 조회할 세금계산서 문서번호 (최대 1,000건) |
Return
Throws
2.3. GetDetailInfo - 상세정보 확인
- 세금계산서 1건의 상세정보를 확인합니다.
Taxinvoice getDetailInfo(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
Return
Throws
2.4. CheckMgtKeyInUse - 문서번호 사용 여부 확인
- 파트너가 세금계산서 관리 목적으로 할당하는 문서번호의 사용여부를 확인합니다.
- 이미 사용 중인 문서번호는 중복 사용이 불가하고, 세금계산서가 삭제된 경우에만 문서번호의 재사용이 가능합니다.
Boolean checkMgtKeyInUse(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKey | String | 24 | Y | 확인할 문서번호 |
Return
boolean - true : (사용중) / false : (미사용중)
Throws
2.5. GetXML - 상세정보 확인(XML)
- 세금계산서 1건의 상세정보를 XML로 반환합니다.
TaxinvoiceXML getXML(String CorpNum, MgtKeyType KeyType, String MgtKey, String UserID) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 | |
UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.6. Search - 목록 조회
- 검색조건에 해당하는 세금계산서를 조회합니다. (최대 조회기간 : 6개월)
TISearchResult Search(String CorpNum, MgtKeyType KeyType, String DType, String SDate, String EDate, String[] State, String[] Type, String[] TaxType, String[] IssueType, Boolean LateOnly, String TaxRegIDType, String TaxRegID, String TaxRegIDYN, String QString, Integer Page, Integer PerPage, String Order, String InterOPYN, String[] RegType, String[] CloseDownState, String MgtKey, String UserID) throws PopbillException
- 페이지 관련 항목(Page, PerPage, Order)을 활용하여 세금계산서 목록을 구현할 수 있습니다.
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
DType | String | 1 | Y |
조회 기준일자 유형: "R" / "W" / "I" 중 택 1
└ R = 등록일자, W = 작성일자, I = 발행일자 |
|
SDate | String | 8 | Y | 조회 기간의 시작일자 (형식 : yyyyMMdd) | |
EDate | String | 8 | Y | 조회 기간의 종료일자 (형식 : yyyyMMdd) | |
State | String[ ] | N |
세금계산서 상태코드
└ 상태코드 2, 3번째 자리에 와일드카드(*) 사용가능. 예) "3**", "60*" └ [참고] 팝빌 상태코드 ※ 미입력시 전체조회 |
||
Type | String[ ] | N |
세금계산서 문서유형 : "N" / "M" 중 선택 (다중 선택 가능)
└ "N" : 일반 └ "M" : 수정 세금계산서 ※ 미입력시 전체조회 |
||
TaxType | String[ ] | N |
과세형태 : "T" / "N" / "Z" 중 선택 (다중 선택 가능)
└ "T" : 과세 └ "N" : 면세 └ "Z" : 영세 ※ 미입력시 전체조회 |
||
IssueType | String[ ] | N |
발행형태 : "N" / "R" / "T" 중 선택 (다중 선택 가능)
└ N = 정발행, R = 역발행, T = 위수탁발행 ※ 미입력시 전체조회 |
||
LateOnly | Boolean | - | N |
지연발행 여부 : null / true / false 중 택 1
└ null = 전체, true = 지연발행, false = 정상발행 |
|
TaxRegIDType | String | 1 | N |
종사업자번호의 주체 : "S" / "B" / "T" 중 택 1
└ "S" : 공급자 └ "B" : 공급받는자 └ "T" : 수탁자 ※ 미입력시 전체조회 |
|
TaxRegID | String | - | N |
종사업장번호
└ 다수건 검색시 콤마(",")로 구분. 예) 1234,1000 ※ 미입력시 전체조회 |
|
TaxRegIDYN | String | 1 | N |
종사업장번호 유무 : null / "0" / "1" 중 택 1
└ null : 전체 └ "0" : 없음 └ "1" : 있음 |
|
QString | String | - | N |
거래처 상호 / 사업자번호 (사업자) / 주민등록번호 (개인) / "9999999999999" (외국인) 중 검색하고자 하는 정보 입력
└ 사업자번호 / 주민등록번호는 하이픈('-')을 제외한 숫자만 입력 ※ 미입력시 전체조회 |
|
Page | Integer | - | N | 목록 페이지번호 (기본값 1) | |
PerPage | Integer | - | N | 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) | |
Order | String | 1 | N |
{DType} 값을 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ "D" : 내림차순(기본값) └ "A" : 오름차순 |
|
InterOPYN | String | 1 | N |
연동문서 여부 : null / "0" / "1" 중 택 1
└ null = 전체, 0 = 일반문서, 1 = 연동문서 ※ 일반문서는 팝빌 사이트를 통해 저장 또는 발행한 세금계산서, 연동문서는 팝빌 API를 통해 저장 또는 발행한 세금계산서 |
|
RegType | String[ ] | N |
전자세금계산서 등록 유형 : "P" / "H" 중 선택 (다중 선택 가능)
└ P = 팝빌에서 등록(발행), H = 홈택스 또는 ASP에서 등록(발행) ※ 미입력시 전체조회 |
||
CloseDownState | String[ ] | N |
휴폐업상태 : "N" / "0" / "1" / "2" / "3" / "4" 중 선택 (다중 선택 가능)
└ N = 미확인, 0 = 미등록, 1 = 사업중, 2 = 폐업, 3 = 휴업, 4 = 확인실패 ※ 미입력시 전체조회 |
||
MgtKey | String | - | N |
세금계산서의 문서번호 / 국세청 승인번호 중 검색하고자 하는 정보 입력
※ 미입력시 전체조회 |
|
UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
2.7. GetLogs - 세금계산서 상태 변경이력 확인
- 세금계산서의 상태에 대한 변경이력을 확인합니다.
TaxinvoiceLog[] getLogs(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
KeyType | MgtKeyType | - | Y |
세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL : 매출 └ BUY : 매입 └ TRUSTEE : 위수탁 |
|
MgtKey | String | 24 | Y | 파트너가 할당한 문서번호 |
Return
Throws
2.8. GetURL - 팝빌 세금계산서 문서함 팝업 URL
- 로그인 상태로 팝빌 사이트의 전자세금계산서 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String getURL(String CorpNum, String UserID, String TOGO) throws PopbillException
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | String | 10 | Y | 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) | |
UserID | String | 50 | N | 팝빌회원 아이디 | |
TOGO | String | - | Y | 접근 메뉴
|
Return
String - 요청에 대한 응답 URL