{"openapi":"3.0.3","info":{"title":"APICK 소득 통합 조회","version":"1.0.0","description":"본인 간편인증 후 국세청의 소득 통합 조회 자료를 확인합니다. 조회연도: 실제로 조회한 전체 귀속연도 목록(4자리 문자열). 금융소득이 없는 연도도 포함한다. 연도별: 귀속연도별 소득 집계. 합계 건수가 0인 연도는 담기지 않아 조회연도보다 적을 수 있다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/req_income_bundle":{"post":{"summary":"소득 통합 조회","description":"본인 간편인증 후 국세청의 소득 통합 조회 자료를 확인합니다. 조회연도: 실제로 조회한 전체 귀속연도 목록(4자리 문자열). 금융소득이 없는 연도도 포함한다. 연도별: 귀속연도별 소득 집계. 합계 건수가 0인 연도는 담기지 않아 조회연도보다 적을 수 있다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"schemaVersion":{"type":"string","description":"결과 스키마 버전 (고정값: \"1.0\")"},"transactionId":{"type":"string","description":"결과 조회에 사용하는 트랜잭션 ID"},"product":{"type":"string","description":"조회 항목 코드. 결과조회에도 같은 값이 오므로 어느 항목의 결과인지 대조할 수 있습니다."},"status":{"type":"string","description":"처리 상태 (AUTH_REQUESTED: 인증 요청 완료)"},"resultAvailable":{"type":"boolean","description":"결과 데이터 포함 여부. 인증 요청 응답은 항상 false 입니다."},"charged":{"type":"boolean","description":"이번 호출의 과금 발생 여부. 실제 발송에 성공하면 true 입니다."},"sources":{"type":"array","items":{}},"message":{"type":"string","description":"상태 메시지 (고정값: \"인증 대기중입니다.\")"},"expiresAt":{"type":"string","description":"인증 유효 기한(ISO 8601). 이 시각까지 승인하지 못하면 인증 실패 처리됩니다."},"success":{"type":"integer","description":"과금 여부0: 실패 또는 재사용(무과금)1: 발송 성공(과금)"},"approvals":{"type":"integer","description":"필요한 간편인증 승인 횟수. 조회 항목 하나당 1회입니다."}},"description":"인증 요청 결과"},"api":{"type":"object","properties":{"success":{"type":"boolean","description":"API 서버 정상 응답 여부"},"cost":{"type":"integer","description":"API 호출 요금"},"ms":{"type":"integer","description":"API 응답 시간"},"pl_id":{"type":"integer","description":"API 결제 로그 ID"}},"description":"API 호출 공통 데이터"}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"이름 (string)","example":"홍길동"},"birthDate":{"type":"string","description":"생년월일 8자리(YYYYMMDD) (string)","example":"19900101"},"phone":{"type":"string","description":"휴대전화 번호 (본인 명의, 숫자만) (string)","example":"01011112222"},"authProvider":{"type":"string","description":"간편인증 방식 (아래 지원 목록 참고) (string)","example":"kakao"},"incomeYears":{"type":"string","description":"소득 조회 연수(1~5). 기본 1 (integer)","example":"3"}},"required":["name","birthDate","phone","authProvider"]}}}}}},"/rest/get_income_bundle":{"post":{"summary":"소득 통합 조회","description":"본인 간편인증 후 국세청의 소득 통합 조회 자료를 확인합니다. 조회연도: 실제로 조회한 전체 귀속연도 목록(4자리 문자열). 금융소득이 없는 연도도 포함한다. 연도별: 귀속연도별 소득 집계. 합계 건수가 0인 연도는 담기지 않아 조회연도보다 적을 수 있다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"schemaVersion":{"type":"string","description":"결과 스키마 버전 (고정값: \"1.0\")"},"transactionId":{"type":"string","description":"트랜잭션 ID"},"product":{"type":"string","description":"조회 항목 코드. 인증요청 응답과 같은 값입니다."},"status":{"type":"string","description":"처리 상태 (위 표 참고)"},"resultAvailable":{"type":"boolean","description":"실제 결과 포함 여부. 과금 여부도 이 값으로 결정됩니다."},"charged":{"type":"boolean","description":"이번 호출의 과금 발생 여부. 최초 결과 반환에서만 true 입니다."},"sources":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"}}},"description":"항상 포함됩니다. 값이 없으면 빈 배열 [] 입니다. 항목이 여러 개인 상품에서 어느 것이 성공·실패했는지 알려줍니다. 각 항목은 source(제공 기관명), type(데이터 종류), status(SUCCESS/FAILED). 수집이 끝나기 전에는 아직 확정되지 않은 기관이 FAILED 로 보일 수 있습니다."},"message":{"type":"string","description":"상태 메시지"},"expiresAt":{"type":"string"},"success":{"type":"integer","description":"과금 여부0: 결과 없음 또는 재조회(무과금)1: 최초 결과 반환(과금)"},"progress":{"type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"}},"description":"진행률(COLLECTING 일 때). total(전체 항목), completed(완료 항목)"},"checkedAt":{"type":"string","description":"실제 정보를 확인한 시각. 한국시간(UTC+09:00) ISO 8601 이며 재조회 유효기간의 기준입니다."},"resultExpiresAt":{"type":"string","description":"결과 재조회 만료 시각. 한국시간(UTC+09:00) ISO 8601 입니다."},"result":{"type":"object","properties":{"personalIncome":{"type":"object","additionalProperties":true,"properties":{"조회연도":{"type":"array","description":"실제로 조회한 전체 귀속연도 목록(4자리 문자열). 금융소득이 없는 연도도 포함한다.","items":{"type":"string"}},"연도별":{"type":"array","description":"귀속연도별 소득 집계. 합계 건수가 0인 연도는 담기지 않아 조회연도보다 적을 수 있다.","items":{"type":"object","properties":{"귀속연도":{"type":"string","description":"귀속연도 4자리"},"소득종류별":{"type":"object","description":"확인된 이자소득·배당소득별 집계. 근로·사업소득은 포함하지 않는다. 확인되지 않은 종류의 키는 생략된다.","properties":{"이자소득":{"type":"object","description":"이자소득이 확인된 경우의 집계(금액 단위 원). 없으면 키 생략. 값이 없으면 생략되거나 빈 값입니다.","properties":{"건수":{"type":"integer","description":"소득 건수"},"소득금액":{"type":"integer","description":"소득금액 합계(원)"},"소득세":{"type":"integer","description":"소득세 합계(원)"},"지방소득세":{"type":"integer","description":"지방소득세 합계(원)"},"농어촌특별세":{"type":"integer","description":"농어촌특별세 합계(원)"},"세액합계":{"type":"integer","description":"소득세 + 지방소득세 + 농어촌특별세(원)"}}},"배당소득":{"type":"object","description":"배당소득이 확인된 경우의 집계(금액 단위 원). 없으면 키 생략. 값이 없으면 생략되거나 빈 값입니다.","properties":{"건수":{"type":"integer","description":"소득 건수"},"소득금액":{"type":"integer","description":"소득금액 합계(원)"},"소득세":{"type":"integer","description":"소득세 합계(원)"},"지방소득세":{"type":"integer","description":"지방소득세 합계(원)"},"농어촌특별세":{"type":"integer","description":"농어촌특별세 합계(원)"},"세액합계":{"type":"integer","description":"소득세 + 지방소득세 + 농어촌특별세(원)"}}}}},"합계":{"type":"object","description":"그 연도의 전체 합계","properties":{"건수":{"type":"integer","description":"소득 건수"},"소득금액":{"type":"integer","description":"소득금액 합계(원)"},"소득세":{"type":"integer","description":"소득세 합계(원)"},"지방소득세":{"type":"integer","description":"지방소득세 합계(원)"},"농어촌특별세":{"type":"integer","description":"농어촌특별세 합계(원)"},"세액합계":{"type":"integer","description":"소득세 + 지방소득세 + 농어촌특별세(원)"}}}}}}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"cashReceiptDeduction":{"type":"object","properties":{"조회연도":{"type":"array","items":{"type":"string"},"description":"실제로 조회된 귀속연도 목록(4자리 문자열)."},"전체합계":{"type":"object","properties":{"건수":{"type":"integer","description":"현금영수증 사용 건수"},"사용금액":{"type":"integer","description":"사용금액 합계(원)"},"소득공제건수":{"type":"integer","description":"소득공제에 반영된 건수"},"소득공제금액":{"type":"integer","description":"소득공제에 반영된 금액(원)"}},"description":"조회한 전체 연도의 합계."},"연도별":{"type":"object","items":{"type":"object","properties":{"귀속연도":{"type":"string"},"합계":{"type":"object","properties":{"건수":{"type":"integer"},"사용금액":{"type":"integer"},"소득공제건수":{"type":"integer"},"소득공제금액":{"type":"integer"}}},"사용내역":{"type":"array","items":{"type":"object","properties":{"거래일시":{"type":"string"},"가맹점":{"type":"string"},"금액":{"type":"integer"},"승인번호":{"type":"string"},"거래구분":{"type":"string"},"거래상태":{"type":"string"},"소득공제대상":{"type":"boolean"},"소득공제반영":{"type":"boolean"}}}}}},"description":"귀속연도별 합계와 사용내역.","properties":{"귀속연도":{"type":"string","description":"귀속연도 4자리"},"합계":{"type":"object","description":"그 연도의 합계","properties":{"건수":{"type":"integer","description":"현금영수증 사용 건수"},"사용금액":{"type":"integer","description":"사용금액 합계(원)"},"소득공제건수":{"type":"integer","description":"소득공제에 반영된 건수"},"소득공제금액":{"type":"integer","description":"소득공제에 반영된 금액(원)"}}},"사용내역":{"type":"array","description":"건별 사용내역. 사용이 없으면 빈 배열이다.","items":{"type":"object","properties":{"거래일시":{"type":"string","description":"승인 일시"},"가맹점":{"type":"string","description":"가맹점명"},"금액":{"type":"integer","description":"승인 금액(원)"},"승인번호":{"type":"string","description":"현금영수증 승인번호"},"거래구분":{"type":"string","description":"승인·취소 구분"},"거래상태":{"type":"string","description":"거래 상태"},"소득공제대상":{"type":"boolean","description":"소득공제 대상이면 true, 아니면 false."},"소득공제반영":{"type":"boolean","description":"소득공제가 반영됐으면 true, 아니면 false."}}}}}}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"incomeByPayer":{"type":"object","properties":{"조회연도":{"type":"array","items":{"type":"string"},"description":"실제로 조회한 귀속연도 목록(4자리 문자열)."},"전체합계":{"type":"object","properties":{"건수":{"type":"integer","description":"지급명세서 건수"},"지급액":{"type":"integer","description":"그 유형 기준 금액의 합계(원). 유형마다 기준 항목이 다르다(총지급액·과세소득·용역제공대가·급여 등)."},"소득세":{"type":"integer","description":"소득세 합계(원)"},"지방소득세":{"type":"integer","description":"지방소득세 합계(원)"}},"description":"조회한 전체 유형·연도의 합계. 지급명세서가 하나도 없으면 건수가 0이다."},"유형별":{"type":"object","items":{"type":"object","properties":{"유형":{"type":"string"},"합계":{"type":"object","properties":{"건수":{"type":"integer"},"지급액":{"type":"integer"},"소득세":{"type":"integer"},"지방소득세":{"type":"integer"}}},"내역":{"type":"array","items":{"type":"object","properties":{"지급명세서종류":{"type":"string"},"지급자":{"type":"string"},"사업자등록번호":{"type":"string"},"귀속연도":{"type":"string"},"지급연도":{"type":"string"},"소득구분":{"type":"string"},"업종구분":{"type":"string"},"용역구분":{"type":"string"},"총지급액":{"type":"integer"},"과세소득":{"type":"integer"},"용역제공대가":{"type":"integer"},"급여 등":{"type":"integer"},"인정상여금액":{"type":"integer"},"비과세소득":{"type":"integer"},"필요경비":{"type":"integer"},"소득금액":{"type":"integer"},"소득세":{"type":"integer"},"지방소득세":{"type":"integer"}}}}}},"description":"지급명세서 자료종류별 소득내역. 내역이 있는 유형만 담긴다.","properties":{"유형":{"type":"string","description":"자료종류. 사업장제공자·간이기타·간이사업·간이근로·일용 중 하나다."},"합계":{"type":"object","description":"그 유형의 합계","properties":{"건수":{"type":"integer","description":"지급명세서 건수"},"지급액":{"type":"integer","description":"그 유형 기준 금액의 합계(원). 유형마다 기준 항목이 다르다(총지급액·과세소득·용역제공대가·급여 등)."},"소득세":{"type":"integer","description":"소득세 합계(원)"},"지방소득세":{"type":"integer","description":"지방소득세 합계(원)"}}},"내역":{"type":"array","description":"지급자별 소득 한 건씩. 자료종류와 값 존재 여부에 따라 하위 필드가 생략된다.","items":{"type":"object","properties":{"지급명세서종류":{"type":"string","description":"지급명세서 종류 표기"},"지급자":{"type":"string","description":"지급자(징수의무자)명"},"사업자등록번호":{"type":"string","description":"지급자 사업자등록번호 10자리(하이픈 포함)"},"귀속연도":{"type":"string","description":"귀속연도 4자리"},"지급연도":{"type":"string","description":"지급연도 4자리. 간이기타·간이사업에만 온다."},"소득구분":{"type":"string","description":"소득구분 표기. 간이기타에만 온다."},"업종구분":{"type":"string","description":"업종구분 표기. 간이사업에만 온다."},"용역구분":{"type":"string","description":"용역구분 표기. 사업장제공자에만 온다."},"총지급액":{"type":"integer","description":"총지급액(원). 간이기타·간이사업에 온다."},"과세소득":{"type":"integer","description":"과세소득(원). 일용에 온다."},"용역제공대가":{"type":"integer","description":"용역제공대가(원). 사업장제공자에 온다."},"급여 등":{"type":"integer","description":"급여 등(원). 간이근로에 온다."},"인정상여금액":{"type":"integer","description":"인정상여금액(원). 간이근로에 온다."},"비과세소득":{"type":"integer","description":"비과세소득(원). 일용에 온다."},"필요경비":{"type":"integer","description":"필요경비(원). 간이기타에 온다."},"소득금액":{"type":"integer","description":"소득금액(원). 간이기타에 온다."},"소득세":{"type":"integer","description":"소득세(원)"},"지방소득세":{"type":"integer","description":"지방소득세(원)"}}}}}}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"incomeDataCheck":{"type":"object","properties":{"조회연도":{"type":"array","items":{"type":"string"},"description":"실제로 조회된 귀속연도 목록(4자리 문자열)."},"연도별":{"type":"object","items":{"type":"object","properties":{"귀속연도":{"type":"string"},"연간소득총액":{"type":"integer"},"근로소득":{"type":"integer"},"근로소득(간이)":{"type":"integer"},"사업소득(간이)":{"type":"integer"},"원천징수 사업소득":{"type":"integer"},"사업장 사업소득":{"type":"integer"},"금융소득":{"type":"integer"},"연금소득":{"type":"integer"},"기타소득":{"type":"integer"},"종교인소득":{"type":"integer"}}},"description":"귀속연도별 소득자료 합계. 자료가 없는 연도는 담기지 않으며 확인되지 않은 금액 필드는 생략될 수 있다.","properties":{"귀속연도":{"type":"string","description":"귀속연도 4자리"},"연간소득총액":{"type":"integer","description":"연간 소득 총액(원)"},"근로소득":{"type":"integer","description":"상용·일용 근로소득 합계(원)"},"근로소득(간이)":{"type":"integer","description":"간이지급명세서로 제출된 근로소득(원)"},"사업소득(간이)":{"type":"integer","description":"간이지급명세서로 제출된 사업소득(원)"},"원천징수 사업소득":{"type":"integer","description":"원천징수된 사업소득(원)"},"사업장 사업소득":{"type":"integer","description":"사업장에서 발생한 사업소득(원)"},"금융소득":{"type":"integer","description":"이자·배당 등 금융소득(원)"},"연금소득":{"type":"integer","description":"연금소득(원)"},"기타소득":{"type":"integer","description":"기타소득(원)"},"종교인소득":{"type":"integer","description":"종교인소득(원)"}}},"근로소득상세":{"type":"object","properties":{"귀속연도":{"type":"string","description":"귀속연도 4자리"},"신청 구분":{"type":"string","description":"상반기분 또는 하반기분"},"근로소득 합계":{"type":"integer","description":"상용·일용 근로소득 합계(원)"},"상반기 근로소득":{"type":"integer","description":"상반기 근로소득(원)"},"하반기 근로소득":{"type":"integer","description":"하반기 근로소득(원)"},"상용근로소득":{"type":"integer","description":"상용근로소득 합계(원)"},"상반기 상용근로소득":{"type":"integer","description":"상반기 상용근로소득(원)"},"하반기 상용근로소득":{"type":"integer","description":"하반기 상용근로소득(원)"},"일용근로소득":{"type":"integer","description":"일용근로소득 합계(원)"},"상반기 일용근로소득":{"type":"integer","description":"상반기 일용근로소득(원)"},"하반기 일용근로소득":{"type":"integer","description":"하반기 일용근로소득(원)"}},"description":"조회 시점의 반기 기준 근로소득 상세. 키는 항상 존재하며 조회 기간이 아니면 null이다.","nullable":true},"지급자별":{"type":"object","items":{"type":"object","properties":{"자료출처":{"type":"string"},"지급자 상호(법인명)":{"type":"string"},"지급자 사업자등록번호":{"type":"string"},"수입금액":{"type":"integer"},"업종":{"type":"string"},"업종코드":{"type":"string"}}},"description":"지급자별 소득자료. 자료가 없으면 빈 배열이며 하위 필드는 값이 있을 때만 포함된다.","properties":{"자료출처":{"type":"string","description":"소득자료 종류 표기"},"지급자 상호(법인명)":{"type":"string","description":"지급자 상호 또는 법인명"},"지급자 사업자등록번호":{"type":"string","description":"지급자 사업자등록번호. 하이픈 없이 10자리로 온다."},"수입금액":{"type":"integer","description":"수입금액(원)"},"업종":{"type":"string","description":"업종 표기"},"업종코드":{"type":"string","description":"업종코드"}}}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."}},"description":"조회된 결과 묶음. 실제 데이터가 있을 때만 포함됩니다."},"errorCode":{"type":"string","description":"오류 구분. RESULT_EXPIRED(재조회 기간 만료) / AUTH_EXPIRED / AUTH_REJECTED / COLLECT_FAILED"}},"description":"상태·결과"},"api":{"type":"object","properties":{"success":{"type":"boolean","description":"API 서버 정상 응답 여부"},"cost":{"type":"integer","description":"API 호출 요금"},"ms":{"type":"integer","description":"API 응답 시간"},"pl_id":{"type":"integer","description":"API 결제 로그 ID"}},"description":"API 호출 공통 데이터"}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"transactionId":{"type":"string","description":"/rest/req_income_bundle 가 반환한 트랜잭션 ID (string)","example":"9f2c4a7b1d8e35c60a4f7b2d1e9c803a"}},"required":["transactionId"]}}}}}}},"x-code-tables":[],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}