팝빌의 전자세금계산서 API는 문서관리번호를 이용하여 전송내역 및 전송상태 단건(GetInfo) / 대량(GetInfos) 조회 기능 뿐만아니라 목록 조회(Search) 기능을 제공하고 있습니다. API 요청 URI Query String 항목과 응답전문 항목에 대한 설명을 참조하여 연동개발을 진행하시기 바랍니다.
목록 조회(Search) API 요청정보
요청정보를 구성하는 URI Query String은 다음과 같이 구성됩니다.
필수항목을 반드시 작성하여 요청해야 정상적인 결과를 응답받을 수 있습니다.
| 항목명 | 변수명 | 타입 | 필수 | 비고 |
|---|---|---|---|---|
| 일자유형 | DType | String |
○ |
R-등록일시,W-작성일자,I-발행일시 중 택1 |
| 시작일자 | SDate | String |
○ |
작성형식 yyyyMMdd |
| 종료일자 | EDate | String |
○ |
작성형식 yyyyMMdd |
| 상태코드 배열 | State | List | – |
배열로 구성, 2,3번째 자리에 와일드카드(*) 사용 가능 ex) 100,2**,3*4 |
| 문서유형 배열 | Type | List | – | 배열로 구성, N-일반, M-수정 |
| 과세형태 배열 | TaxType | List | – | 배열로 구성, T-과세, N-면세, Z-영세 |
| 발행형태 배열 | IssueType | List | – | 배열로 구성, N-정발행, R-역발행, Z-위수탁 |
| 지연발행 여부 | LateOnly | String | – | 0-정상발행, 1-지연발행 중 택1, 미기재시 전체조회 |
| 종사업장번호 유무 | TaxRegIDYN | String | – | 공백-전체조회, 0-종사업장번호 없음, 1-종사업장번호 있음 |
| 종사업장번호 사업자 유형 | TaxRegIDType | String | – | S-공급자, B-공급받는자, T-수탁자 |
| 종사업장번호 | TaxRegID | String | – | 다수 종사업장 번호 검색 조건은 콤마(“,”)로 구분 |
| 페이지 번호 | Page | Number | – | 조회 페이지 번호 |
| 페이지당 검색개수 | PerPage | Number | – | 기본값 500, 최대값 1000 |
| 정렬 방향 | Order | String | – | D-내림차순(기본값), A-오름차순 |
목록 조회(Search) API 응답전문 항목
응답전문은 요청결과정보와 (세금)계산서 상태정보 배열로 구성됩니다.
| 항목 | 변수명 | 타입 | 설명 |
|---|---|---|---|
| 상태코드 | code | Number | 요청에 대한 응답 상태코드 |
| 메시지 | message | String | 요청에 대한 응답 메시지 |
| 총 검색결과 건수 | total | Number | |
| 페이지당 검색개수 | perPage | Number | 기본값 500, 최대값 1000 |
| 페이지 번호 | pageNum | Number | |
| 페이지 개수 | pageCount | Number | |
| 상태정보 배열 | list[] | Array | 요약정보 및 상태정보 배열 |
| 팝빌 관리번호 | ㄴitemKey | String | 팝빌이 부여한 관리번호 |
| 과세형태 | ㄴtaxType | String | “과세”, “영세”, “면세” 중 반환 |
| 작성일자 | ㄴwriteDate | String | 형식 yyyyMMdd |
| 임시저장 일자 | ㄴregDT | String | 형식 yyyyMMdd |
| 발행형태 | ㄴissueType | String | “정발행”, ”역발행”, ”위수탁” 중 반환 |
| 공급가액 합계 | ㄴsupplyCostTotal | String | |
| 세액 합계 | ㄴtaxTotal | String | |
| 영수/청구 | ㄴpurposeType | String | “영수”, “청구” 중 반환 |
| 발행일시 | ㄴissueDT | String | 표시형식 yyyyMMddHHmmss |
| 지연발행 여부 | ㄴlateIssueYN | Boolean | true-지연발행, false-정상발행 |
| 발행예정일시 | ㄴpreIssueDT | String | 표시형식 yyyyMMddHHmmss |
| 개봉 여부 | ㄴopenYN | Boolean | true-개봉, false-미개봉 |
| 개봉 일시 | ㄴopenDT | String | 작성형식 yyyyMMddHHmmss |
| 상태메모 | ㄴstateMemo | String | |
| 상태코드 | ㄴstateCode | Number | [참고] 전자(세금)계산서 상태코드 [바로가기] |
| 상태 변경일시 | ㄴstateDT | String | 표시형식 yyyyMMddHHmmss |
| 국세청승인번호 | ㄴntsconfirmNum | String | 전자(세금)계산서의 국세청승인번호 |
| 국세청 전송결과 | ㄴntsresult | String | |
| 국세청 전송일시 | ㄴntssendDT | String | 표시형식 yyyyMMddHHmmss |
| 국세청 결과 수신일시 | ㄴntsresultDT | String | 표시형식 yyyyMMddHHmmss |
| 전송실패 사유코드 | ㄴntssendErrCode | String | |
| 수정 사유코드 | ㄴmodifyCode | Number |
지금까지 전자세금계산서 API의 목록조회(Search) API에 대해 안내해 드렸습니다. 전자세금계산서 API에 대한 자세한 사항은 [ 링크허브 자료실 > 전자세금계산서 API 연동매뉴얼 ] 참조하시기 바랍니다.
고객님들의 편의를 위하여 이메일, 전화 등 다양한 채널을 열어놓고 있으니 언제든지 연락주시기 바랍니다.
링크허브 개발팀 정요한 과장 / T.1600-9854 / D. 070-4304-2991/ E. code@linkhub.co.kr