portone_server_sdk.platform.company

Contents

portone_server_sdk.platform.company#

Classes

B2bBusinessInfo

사업자등록 정보

B2bBusinessInfoResult

사업자등록 정보조회 결과

GetB2bBusinessInfosBody

사업자등록 정보 조회를 위한 입력 정보

GetB2bBusinessInfosResponse

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

GetPlatformCompanyStatePayload

사업자 조회 성공 응답 정보

PlatformCompanyState

CompanyClient

Exceptions

GetB2bBusinessInfosError

GetPlatformCompanyStateError

exception portone_server_sdk.platform.company.GetB2bBusinessInfosError#

Bases: PortOneError

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#
exception portone_server_sdk.platform.company.GetPlatformCompanyStateError#

Bases: PortOneError

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#
class portone_server_sdk.platform.company.B2bBusinessInfo#

Bases: object

사업자등록 정보

brn: str#

사업자등록번호

name: str#

상호

ceo_name: str#

대표자명

zip_code: str#

우편번호

address: str#

주소

business_entity_type: str#

사업자 유형

business_status: str#

사업 상태

taxation_type: str#

과세 유형

opening_date: str#

개업일

business_type: str#

업태

business_class: str#

종목

business_category_code: str#

업종코드

simplified_taxation_type_date: str | None#

간이과세-일반과세 전환일

closing_date: str | None#

폐업일

corp_reg_no: str | None#

법인등록번호

phone_number: str | None#

전화번호

tax_office_code: str | None#

관할세무서코드

tax_office_name: str | None#

관할세무서명

class portone_server_sdk.platform.company.B2bBusinessInfoResult#

Bases: object

사업자등록 정보조회 결과

brn: str#

사업자등록번호

business_info: B2bBusinessInfo | None#

사업자등록 정보

error: str | None#

조회 실패 시 에러 메시지

class portone_server_sdk.platform.company.GetB2bBusinessInfosBody#

Bases: object

사업자등록 정보 조회를 위한 입력 정보

brn_list: list[str]#

조회할 사업자등록번호 리스트

class portone_server_sdk.platform.company.GetB2bBusinessInfosResponse#

Bases: object

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

result: list[B2bBusinessInfoResult]#

사업자등록 정보 리스트

class portone_server_sdk.platform.company.GetPlatformCompanyStatePayload#

Bases: object

사업자 조회 성공 응답 정보

company_state: PlatformCompanyState#

사업자 정보

company_verification_id: str#

사업자 검증 아이디

class portone_server_sdk.platform.company.PlatformCompanyState#

Bases: object

taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE', 'ASSIGNED_ID_NUMBER', 'SPECIAL'] | str#
business_status: Literal['IN_BUSINESS', 'CLOSED', 'SUSPENDED'] | str#
taxation_type_date: str | None#

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다. (yyyy-MM-dd)

closed_suspended_date: str | None#

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다. (yyyy-MM-dd)

class portone_server_sdk.platform.company.CompanyClient#

Bases: object

get_b2b_business_infos(*, brn_list: list[str]) → GetB2bBusinessInfosResponse#

사업자등록 정보조회

요청된 사업자등록번호 리스트에 해당하는 사업자등록 정보를 조회합니다. 해당 API 사용을 위해서는 별도 문의가 필요합니다.

Parameters:

brn_list (list[str]) – 조회할 사업자등록번호 리스트

Raises:

  • GetB2bBusinessInfosError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_b2b_business_infos_async(*, brn_list: list[str]) → GetB2bBusinessInfosResponse#

사업자등록 정보조회

요청된 사업자등록번호 리스트에 해당하는 사업자등록 정보를 조회합니다. 해당 API 사용을 위해서는 별도 문의가 필요합니다.

Parameters:

brn_list (list[str]) – 조회할 사업자등록번호 리스트

Raises:

  • GetB2bBusinessInfosError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_platform_company_state(*, business_registration_number: str) → GetPlatformCompanyStatePayload#

사업자 조회

사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다.

Parameters:

business_registration_number (str) – 사업자등록번호

Raises:

  • GetPlatformCompanyStateError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_platform_company_state_async(*, business_registration_number: str) → GetPlatformCompanyStatePayload#

사업자 조회

사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다.

Parameters:

business_registration_number (str) – 사업자등록번호

Raises:

  • GetPlatformCompanyStateError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

Contents