전자세금계산서 목록 조회 API 안내

2017.07.27

팝빌의 전자세금계산서 API는 문서관리번호를 이용하여 전송내역 및 전송상태 단건(GetInfo) / 대량(GetInfos) 조회 기능 뿐만아니라 목록 조회(Search) 기능을 제공하고 있습니다. API 요청 URI Query String 항목과 응답전문 항목에 대한 설명을 참조하여 연동개발을 진행하시기 바랍니다.

목록 조회(Search) API 요청정보

요청정보를 구성하는 URI Query String은 다음과 같이 구성됩니다.

필수항목을 반드시 작성하여 요청해야 정상적인 결과를 응답받을 수 있습니다.

항목명 변수명 타입 필수 비고
일자유형 DType String

R-등록일시,W-작성일자,I-발행일시 중 택1
시작일자 SDate String

작성형식 yyyyMMdd
종료일자 SDate String

작성형식 yyyyMMdd
상태코드 State List

배열로 구성, 2,3번째 자리에 와일드카드(*) 사용 가능

ex) 100,2**,3*4

[참고] 전자(세금)계산서 상태코드   [바로가기]

문서유형 Type List 배열로 구성, N-일반, M-수정
과세형태 TaxType List 배열로 구성, T-과세, N-면세, Z-영세
지연발행 여부 LateOnly String 0-정상발행, 1-지연발행 중 택1, 미기재시 전체조회
페이지 번호 Page Number 조회 페이지 번호
페이지당 검색개수 PerPage Number 기본값 500, 최대값 1000
페이지당 검색개수 PerPage Number 기본값 500, 최대값 1000

목록 조회(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