사업자 관련 API

파트너 정산 서비스의 사업자와 관련된 API 입니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
B2bBusinessInfo: { brn, name, ceoName, ... }
사업자등록 정보

사업자등록 정보

B2bBusinessInfoResult: { brn, businessInfo, error, ... }
사업자등록 정보조회 결과

사업자등록 정보조회 결과

B2bExternalServiceError: { type, message }
외부 서비스에서 에러가 발생한 경우

외부 서비스에서 에러가 발생한 경우

B2bNotEnabledError: { type, message }
B2B 기능이 활성화되지 않은 경우

B2B 기능이 활성화되지 않은 경우

ForbiddenError: { type, message }
요청이 거절된 경우

요청이 거절된 경우

GetB2bBusinessInfosError: B2bExternalServiceError | B2bNotEnabledError | ForbiddenError | ...
GetB2bBusinessInfosError
GetB2bBusinessInfosResponse: { result }
사업자등록 정보 조회 성공 응답

사업자등록 정보 조회 성공 응답

GetPlatformCompanyStateError: ForbiddenError | InvalidRequestError | PlatformCompanyNotFoundError | ...
GetPlatformCompanyStateError
GetPlatformCompanyStatePayload: { companyState, companyVerificationId }
사업자 조회 성공 응답 정보

사업자 조회 성공 응답 정보

InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

PlatformBusinessStatus: "IN_BUSINESS" | "CLOSED" | "SUSPENDED"
플랫폼 사업자 상태

플랫폼 사업자 상태

PlatformCompanyNotFoundError: { type, message }
사업자 정보를 찾을 수 없는 경우

사업자 정보를 찾을 수 없는 경우

PlatformCompanyState: { taxationType, taxationTypeDate, businessStatus, ... }
PlatformCompanyState
PlatformExternalApiFailedError: { type, message }
외부 api 오류

외부 api 오류

PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

PlatformTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 과세 유형

플랫폼 과세 유형

UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우

인증 정보가 올바르지 않은 경우