PortOne REST API - V2
API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.
V2 API hostname: api.portone.io
요청 및 응답 형식
요청과 응답의 본문은 JSON 형식입니다.
API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent
함수 등을 사용할 수 있습니다.
인증 방식
V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 관리자콘솔 내 결제연동 탭에서 발급받으실 수 있습니다.
인증 관련 API를 제외한 모든 API는 HTTP Authorization
헤더로 아래 형식의 인증 정보를 전달해주셔야 합니다.
Authorization: PortOne MY_API_SECRET
GET 요청 시 Body 대신 Query 사용하기
GET 요청 시에 Body를 전달해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.
이 경우, Body 객체를 requestBody
Query 필드에 넣어주시면 됩니다.
하위호환성
포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.
-
현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.
-
입력 형식 내 필드 정의가 삭제되지 않습니다.
-
필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.
- 오로지 선택 입력 정보만 추가될 수 있습니다.
-
하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
-
enum 타입의 값이 삭제되지 않습니다.
-
-
출력 형식이 확장될 수 있지만, 축소되지 않습니다.
-
출력 형식 내 필드 정의가 삭제되지 않습니다.
-
사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.
- 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
- 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
-
하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
-
단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.
- 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.
-
UNSTABLE
이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.
결제 관련 API
목차
결제 예약 관련 API
빌링키 관련 API
현금 영수증 관련 API
프로모션 관련 API
본인인증 관련 API
목차
특정 PG사 관련 API
대사 서비스 API
세금계산서 API
세금계산서 발행 관련 API
목차
일괄 세금계산서 조회
Request
Path
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
일괄 세금계산서 상태
그룹 생성 방식
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_BULK_TAX_INVOICE_NOT_FOUND"
일 때의 타입
일괄 세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
파일 업로드 URL 생성
Request
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
200 Ok
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 엑셀 파일(csv) 다운로드
Request
body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기
Body
세금계산서 다건 조회 필터
Response
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
세금계산서 임시저장 수정
Request
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
taxInvoiceKeyType이 TAX_INVOICE_ID가 아닌 경우 필수 값입니다.
세금계산서 식별자 유형
세금계산서 생성 요청 정보
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_CANNOT_CHANGE_TAX_TYPE"
일 때의 타입
세금계산서 과세 유형을 수정할 수 없는 경우
type
이(가)"B2B_DOCUMENT_KEY_CANNOT_BE_CHANGED"
일 때의 타입
문서번호 수정이 요청된 경우
type
이(가)"B2B_ISSUANCE_TYPE_MISMATCH"
일 때의 타입
세금계산서 발행 유형이 올바르지 않은 경우
type
이(가)"B2B_MODIFICATION_NOT_PROVIDED"
일 때의 타입
세금계산서 수정 입력 정보를 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_NOT_DRAFTED_STATUS"
일 때의 타입
세금계산서가 임시저장 완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_RECIPIENT_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급 받는자 문서 번호가 이미 사용 중인 경우
type
이(가)"B2B_TAX_INVOICE_STATUS_NOT_SENDING_COMPLETED"
일 때의 타입
원본 세금계산서가 전송완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_SUPPLIER_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급자 문서 번호가 이미 사용 중인 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_ORIGINAL_TAX_INVOICE_NOT_FOUND"
일 때의 타입
원본 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_RECIPIENT_NOT_FOUND"
일 때의 타입
공급받는자가 존재하지 않은 경우
type
이(가)"B2B_SUPPLIER_NOT_FOUND"
일 때의 타입
공급자가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
409 Error
type
이(가)"B2B_ID_ALREADY_EXISTS"
일 때의 타입
ID가 이미 사용중인 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 임시 저장
Request
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
세금계산서 생성 요청 정보
수정 세금계산서 생성 입력 정보
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_CANNOT_CHANGE_TAX_TYPE"
일 때의 타입
세금계산서 과세 유형을 수정할 수 없는 경우
type
이(가)"B2B_ISSUANCE_TYPE_MISMATCH"
일 때의 타입
세금계산서 발행 유형이 올바르지 않은 경우
type
이(가)"B2B_MODIFICATION_NOT_PROVIDED"
일 때의 타입
세금계산서 수정 입력 정보를 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_RECIPIENT_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급 받는자 문서 번호가 이미 사용 중인 경우
type
이(가)"B2B_TAX_INVOICE_STATUS_NOT_SENDING_COMPLETED"
일 때의 타입
원본 세금계산서가 전송완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_SUPPLIER_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급자 문서 번호가 이미 사용 중인 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_ORIGINAL_TAX_INVOICE_NOT_FOUND"
일 때의 타입
원본 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_RECIPIENT_NOT_FOUND"
일 때의 타입
공급받는자가 존재하지 않은 경우
type
이(가)"B2B_SUPPLIER_NOT_FOUND"
일 때의 타입
공급자가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
409 Error
type
이(가)"B2B_ID_ALREADY_EXISTS"
일 때의 타입
ID가 이미 사용중인 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 즉시 정발행
Request
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
세금계산서 생성 요청 정보
수정 세금계산서 생성 입력 정보
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_CANNOT_CHANGE_TAX_TYPE"
일 때의 타입
세금계산서 과세 유형을 수정할 수 없는 경우
type
이(가)"B2B_ISSUANCE_TYPE_MISMATCH"
일 때의 타입
세금계산서 발행 유형이 올바르지 않은 경우
type
이(가)"B2B_MODIFICATION_NOT_PROVIDED"
일 때의 타입
세금계산서 수정 입력 정보를 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_RECIPIENT_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급 받는자 문서 번호가 이미 사용 중인 경우
type
이(가)"B2B_TAX_INVOICE_STATUS_NOT_SENDING_COMPLETED"
일 때의 타입
원본 세금계산서가 전송완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_SUPPLIER_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급자 문서 번호가 이미 사용 중인 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_ORIGINAL_TAX_INVOICE_NOT_FOUND"
일 때의 타입
원본 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_RECIPIENT_NOT_FOUND"
일 때의 타입
공급받는자가 존재하지 않은 경우
type
이(가)"B2B_SUPPLIER_NOT_FOUND"
일 때의 타입
공급자가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
409 Error
type
이(가)"B2B_ID_ALREADY_EXISTS"
일 때의 타입
ID가 이미 사용중인 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 역발행 즉시 요청
Request
Query
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
세금계산서 생성 요청 정보
수정 세금계산서 생성 입력 정보
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_CANNOT_CHANGE_TAX_TYPE"
일 때의 타입
세금계산서 과세 유형을 수정할 수 없는 경우
type
이(가)"B2B_ISSUANCE_TYPE_MISMATCH"
일 때의 타입
세금계산서 발행 유형이 올바르지 않은 경우
type
이(가)"B2B_MODIFICATION_NOT_PROVIDED"
일 때의 타입
세금계산서 수정 입력 정보를 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_RECIPIENT_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급 받는자 문서 번호가 이미 사용 중인 경우
type
이(가)"B2B_TAX_INVOICE_STATUS_NOT_SENDING_COMPLETED"
일 때의 타입
원본 세금계산서가 전송완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_SUPPLIER_DOCUMENT_KEY_ALREADY_USED"
일 때의 타입
세금계산서에 공급자 문서 번호가 이미 사용 중인 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_ORIGINAL_TAX_INVOICE_NOT_FOUND"
일 때의 타입
원본 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_RECIPIENT_NOT_FOUND"
일 때의 타입
공급받는자가 존재하지 않은 경우
type
이(가)"B2B_SUPPLIER_NOT_FOUND"
일 때의 타입
공급자가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
409 Error
type
이(가)"B2B_ID_ALREADY_EXISTS"
일 때의 타입
ID가 이미 사용중인 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 파일 첨부
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_DRAFTED_STATUS"
일 때의 타입
세금계산서가 임시저장 완료 상태가 아닌 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_FILE_NOT_FOUND"
일 때의 타입
업로드한 파일을 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 첨부파일 삭제
Request
Path
세금계산서 문서 번호
첨부파일 아이디
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_DRAFTED_STATUS"
일 때의 타입
세금계산서가 임시저장 완료 상태가 아닌 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_ATTACHMENT_NOT_FOUND"
일 때의 타입
세금계산서의 첨부파일을 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 첨부파일 목록 조회
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 역발행 취소 (공급자에 의한 취소)
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_ISSUED_STATUS"
일 때의 타입
세금계산서가 발행된(ISSUED) 상태가 아닌 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 역발행 요청 취소 (공급받는자에 의한 취소)
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_REQUESTED_STATUS"
일 때의 타입
세금계산서가 역발행 대기 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_NO_RECIPIENT_DOCUMENT_KEY"
일 때의 타입
세금계산서에 공급받는자 문서 번호가 기입되지 않은 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 발행 승인
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_DRAFTED_STATUS"
일 때의 타입
세금계산서가 임시저장 완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_NOT_REQUESTED_STATUS"
일 때의 타입
세금계산서가 역발행 대기 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_NO_SUPPLIER_DOCUMENT_KEY"
일 때의 타입
세금계산서에 공급자 문서 번호가 기입되지 않은 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금 계산서 PDF 다운로드 URL 조회
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금 계산서 팝업 URL 조회
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
팝업 URL에 메뉴 레이아웃을 포함 여부를 결정합니다. 기본 값은 true입니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금 계산서 프린트 URL 조회
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 역발행 요청 거부
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Body
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_REQUESTED_STATUS"
일 때의 타입
세금계산서가 역발행 대기 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_NO_SUPPLIER_DOCUMENT_KEY"
일 때의 타입
세금계산서에 공급자 문서 번호가 기입되지 않은 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 역발행 요청
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_CANNOT_CHANGE_TAX_TYPE"
일 때의 타입
세금계산서 과세 유형을 수정할 수 없는 경우
type
이(가)"B2B_ISSUANCE_TYPE_MISMATCH"
일 때의 타입
세금계산서 발행 유형이 올바르지 않은 경우
type
이(가)"B2B_MODIFICATION_NOT_PROVIDED"
일 때의 타입
세금계산서 수정 입력 정보를 찾을 수 없는 경우
type
이(가)"B2B_TAX_INVOICE_NOT_DRAFTED_STATUS"
일 때의 타입
세금계산서가 임시저장 완료 상태가 아닌 경우
type
이(가)"B2B_TAX_INVOICE_NO_RECIPIENT_DOCUMENT_KEY"
일 때의 타입
세금계산서에 공급받는자 문서 번호가 기입되지 않은 경우
type
이(가)"B2B_TAX_INVOICE_STATUS_NOT_SENDING_COMPLETED"
일 때의 타입
원본 세금계산서가 전송완료 상태가 아닌 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_ORIGINAL_TAX_INVOICE_NOT_FOUND"
일 때의 타입
원본 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 국세청 즉시 전송
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
세금계산서
400 Error
type
이(가)"B2B_TAX_INVOICE_NOT_ISSUED_STATUS"
일 때의 타입
세금계산서가 발행된(ISSUED) 상태가 아닌 경우
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금 계산서 조회
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
과세 유형
세금계산서 문서 수정 발행 유형
발행 유형
입력 범위(4자리) : 0 ~ 9999
입력 범위(4자리) : 0 ~ 9999
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
영수/청구
최대 3개
세금 계산서 수정
최대 99개
최대 3개
세금계산서 발행(전자서명) 시점에 자동으로 부여
국세청 발급 결과 코드로 영문 3자리 + 숫자 3자리로 구성됨
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금계산서 삭제
Request
Path
세금계산서 문서 번호
Query
사업자등록번호
query 파라미터로 전달된 문서번호 유형. 기본 값은 TAX_INVOICE_ID이며 SUPPLIER, RECIPIENT, TAX_INVOICE_ID을 지원합니다.
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
Response
200 Ok
400 Error
type
이(가)"B2B_TAX_INVOICE_NON_DELETABLE_STATUS"
일 때의 타입
삭제 가능한 상태는 DRAFTED
, ISSUE_REFUSED
, REQUEST_CANCELLED_BY_RECIPIENT
, ISSUE_CANCELLED_BY_SUPPLIER
, SENDING_FAILED
입니다.
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_BULK_TAX_INVOICE_NOT_FOUND"
일 때의 타입
일괄 세금계산서가 존재하지 않은 경우
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우
세금 계산서 다건조회
Request
body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기
Body
true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
0부터 시작하는 페이지 번호. 기본 값은 0.
각 페이지 당 포함할 객체 수. 기본 값은 500이며 최대 1000까지 요청가능합니다.
세금계산서 다건 조회 필터
Response
200 Ok
반환된 페이지 결과 정보
400 Error
type
이(가)"INVALID_REQUEST"
일 때의 타입
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
401 Error
type
이(가)"UNAUTHORIZED"
일 때의 타입
인증 정보가 올바르지 않은 경우
403 Error
type
이(가)"B2B_NOT_ENABLED"
일 때의 타입
B2B 기능이 활성화되지 않은 경우
type
이(가)"FORBIDDEN"
일 때의 타입
요청이 거절된 경우
404 Error
type
이(가)"B2B_TAX_INVOICE_NOT_FOUND"
일 때의 타입
세금계산서가 존재하지 않은 경우
502 Error
type
이(가)"B2B_EXTERNAL_SERVICE"
일 때의 타입
외부 서비스에서 에러가 발생한 경우