portone_server_sdk.b2b.counterparty

portone_server_sdk.b2b.counterparty#

Classes

`B2bCertificate`
`B2bCounterparty`	거래처
`B2bCounterpartyContact`	거래처 담당자 정보
`B2bCounterpartyContactInput`	거래처 담당자 입력 정보
`B2bCounterpartyCreateOptions`	거래처 생성 옵션
`B2bCounterpartyFilter`	거래처 검색 필터
`B2bCounterpartyInput`	거래처 입력 정보
`B2bCounterpartyVerification`	거래처 검증 정보
`CreateB2bCounterpartyBody`	거래처 생성 요청 정보
`CreateB2bCounterpartyResponse`	거래처 생성 응답 정보
`DeleteB2bCounterpartyBody`	거래처 삭제 요청
`DeleteB2bCounterpartyResponse`	거래처 삭제 응답
`GetB2bCounterpartiesBody`	거래처 검색 요청 정보
`GetB2bCounterpartiesResponse`	거래처 검색 성공 응답
`GetB2bCounterpartyCertificateRegistrationUrlResponse`	인증서 등록 URL 조회 응답 정보
`UpdateB2bCounterpartyBody`	거래처 정보 수정 요청
`UpdateB2bCounterpartyResponse`	거래처 정보 수정 응답
`ValidateB2bCounterpartyCertificateResponse`	인증서 유효성 검증 응답 정보
`CounterpartyClient`

Exceptions

`CreateB2bCounterpartyError`
`DeleteB2bCounterpartyError`
`GetB2bCounterpartiesError`
`GetB2bCounterpartyCertificateError`
`GetB2bCounterpartyCertificateRegistrationUrlError`
`GetB2bCounterpartyError`
`UpdateB2bCounterpartyError`
`ValidateB2bCounterpartyCertificateError`

exception portone_server_sdk.b2b.counterparty.CreateB2bCounterpartyError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.DeleteB2bCounterpartyError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.GetB2bCounterpartiesError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.GetB2bCounterpartyCertificateError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.GetB2bCounterpartyCertificateRegistrationUrlError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.GetB2bCounterpartyError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.UpdateB2bCounterpartyError#

Bases: PortOneError

args#

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

message: str | None#

exception portone_server_sdk.b2b.counterparty.ValidateB2bCounterpartyCertificateError#

Bases: PortOneError

args#

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

message: str | None#

class portone_server_sdk.b2b.counterparty.B2bCertificate#

Bases: object

registered_at: str#: 등록일시 (RFC 3339 date-time)

expired_at: str#: 만료일시 (RFC 3339 date-time)

issuer_name: str#: 발행자명

subject_name: str#: 본인명

certificate_type: Literal['E_TAX', 'PORTONE', 'ETC'] | str#: 인증서 타입

oid: str#: OID

registrant_contact_name: str#: 등록 담당자 성명

registrant_contact_id: str#: 등록 담당자 ID

class portone_server_sdk.b2b.counterparty.B2bCounterparty#

Bases: object

거래처

B2B 거래처 정보입니다.

id: str#: 거래처 고유 아이디

graphql_id: str#

is_for_test: bool#: 테스트 모드 여부

brn: str#

사업자등록번호

- 없이 숫자로만 구성됩니다.

company_name: str#: 상호명

representative_name: str#: 대표자 성명

contact: B2bCounterpartyContact#: 담당자 정보

additional_contacts: list[B2bCounterpartyContact]#

추가 담당자 목록

최대 5명까지 등록할 수 있습니다.

nts_connection_status: Literal['NOT_CONNECTED', 'PENDING_CONNECT', 'CONNECTED', 'PENDING_DISCONNECT', 'ERROR'] | str#: 국세청 연동 상태

address: str | None#: 주소

business_type: str | None#: 업태

business_class: str | None#: 업종

memo: str | None#: 메모

nts_connected_at: str | None#: 국세청 연동 시각 (RFC 3339 date-time)

nts_connection_failed_reason: str | None#: 국세청 연동 실패 사유

partner_id: str | None#

파트너 연동 ID

파트너 연동 거래처인 경우에만 존재합니다.

business_status: Literal['UNKNOWN', 'IN_BUSINESS', 'CLOSED', 'SUSPENDED', 'NOT_FOUND', 'CHECK_PENDING', 'CHECK_FAILED'] | str | None#: 휴폐업 상태

business_status_checked_at: str | None#: 휴폐업 상태 확인 시각 (RFC 3339 date-time)

business_status_verification: B2bCounterpartyVerification | None#: 휴폐업 상태 검증 정보

business_info_verification: B2bCounterpartyVerification | None#: 사업자 정보 검증 정보

applied_at: str | None#: 적용 시각 (RFC 3339 date-time)

class portone_server_sdk.b2b.counterparty.B2bCounterpartyContact#

Bases: object

거래처 담당자 정보

name: str#: 담당자 성명

email: str#: 담당자 이메일

phone_number: str | None#: 담당자 전화번호

memo: str | None#: 담당자 메모

class portone_server_sdk.b2b.counterparty.B2bCounterpartyContactInput#

Bases: object

거래처 담당자 입력 정보

name: str#: 담당자 성명

email: str#: 담당자 이메일

phone_number: str | None#: 담당자 전화번호

memo: str | None#: 담당자 메모

class portone_server_sdk.b2b.counterparty.B2bCounterpartyCreateOptions#

Bases: object

거래처 생성 옵션

check_business_info: bool | None#

사업자 정보 조회 여부

true인 경우 사업자 정보를 조회하여 거래처에 반영합니다.

check_business_status: bool | None#

휴폐업 상태 조회 여부

true인 경우 휴폐업 상태를 조회하여 거래처에 반영합니다.

business_info_verification_id: str | None#

사업자 정보 조회 결과 ID

이전에 조회한 사업자 정보 조회 결과의 ID를 입력하면 재조회 없이 해당 결과를 사용합니다.

business_status_verification_id: str | None#

휴폐업 상태 조회 결과 ID

이전에 조회한 휴폐업 상태 조회 결과의 ID를 입력하면 재조회 없이 해당 결과를 사용합니다.

class portone_server_sdk.b2b.counterparty.B2bCounterpartyFilter#

Bases: object

거래처 검색 필터

id: str | None#

거래처 ID

prefix 검색

brn: str | None#: 사업자등록번호

company_name: str | None#

거래처명

포함 검색

representative_name: str | None#: 대표자명

contact_name: str | None#: 담당자 이름

contact_phone: str | None#: 담당자 전화번호

contact_email: str | None#: 담당자 이메일

business_statuses: list[Literal['UNKNOWN', 'IN_BUSINESS', 'CLOSED', 'SUSPENDED', 'NOT_FOUND', 'CHECK_PENDING', 'CHECK_FAILED'] | str] | None#: 휴폐업 상태

nts_connection_statuses: list[Literal['NOT_CONNECTED', 'PENDING_CONNECT', 'CONNECTED', 'PENDING_DISCONNECT', 'ERROR'] | str] | None#: 국세청 연동 상태

counterparty_ids: list[str] | None#

거래처 ID 목록

특정 ID 목록으로 필터링

class portone_server_sdk.b2b.counterparty.B2bCounterpartyInput#

Bases: object

거래처 입력 정보

brn: str#

사업자등록번호

- 없이 숫자로만 구성됩니다.

name: str | None#: 거래처명

representative_name: str | None#: 대표자 성명

address: str | None#: 주소

business_type: str | None#: 업태

business_class: str | None#: 업종

contact: B2bCounterpartyContactInput | None#: 담당자 정보

additional_contacts: list[B2bCounterpartyContactInput] | None#

추가 담당자 목록

최대 5명까지 등록할 수 있습니다.

memo: str | None#: 메모

class portone_server_sdk.b2b.counterparty.B2bCounterpartyVerification#

Bases: object

거래처 검증 정보

id: str#: 외부 API 사용 ID

checked_at: str#: 검증 시각 (RFC 3339 date-time)

class portone_server_sdk.b2b.counterparty.CreateB2bCounterpartyBody#

Bases: object

거래처 생성 요청 정보

counterparty: B2bCounterpartyInput#: 거래처 정보

counterparty_id: str | None#

거래처 아이디

입력하지 않으면 임의의 ID가 채번됩니다.

options: B2bCounterpartyCreateOptions | None#: 거래처 생성 옵션

class portone_server_sdk.b2b.counterparty.CreateB2bCounterpartyResponse#

Bases: object

거래처 생성 응답 정보

counterparty: B2bCounterparty#: 거래처 정보

class portone_server_sdk.b2b.counterparty.DeleteB2bCounterpartyBody#

Bases: object

거래처 삭제 요청

class portone_server_sdk.b2b.counterparty.DeleteB2bCounterpartyResponse#

Bases: object

거래처 삭제 응답

class portone_server_sdk.b2b.counterparty.GetB2bCounterpartiesBody#

Bases: object

거래처 검색 요청 정보

page: PageInput | None#: 페이지 정보

filter: B2bCounterpartyFilter | None#: 검색 필터

class portone_server_sdk.b2b.counterparty.GetB2bCounterpartiesResponse#

Bases: object

거래처 검색 성공 응답

page: PageInfo#: 페이지 정보

items: list[B2bCounterparty]#: 거래처 목록

class portone_server_sdk.b2b.counterparty.GetB2bCounterpartyCertificateRegistrationUrlResponse#

Bases: object

인증서 등록 URL 조회 응답 정보

url: str#: 인증서 등록 URL

class portone_server_sdk.b2b.counterparty.UpdateB2bCounterpartyBody#

Bases: object

거래처 정보 수정 요청

counterparty: B2bCounterpartyInput#: 거래처 정보

options: B2bCounterpartyCreateOptions | None#

확인 옵션

사업자 정보 및 휴폐업 상태 조회 옵션입니다.

class portone_server_sdk.b2b.counterparty.UpdateB2bCounterpartyResponse#

Bases: object

거래처 정보 수정 응답

counterparty: B2bCounterparty#: 거래처 정보

class portone_server_sdk.b2b.counterparty.ValidateB2bCounterpartyCertificateResponse#

Bases: object

인증서 유효성 검증 응답 정보

is_valid: bool#: 인증서 유효 여부

class portone_server_sdk.b2b.counterparty.CounterpartyClient#

Bases: object

get_b2b_counterparty_certificate_registration_url(*, brn: str, test: bool | None = None) → GetB2bCounterpartyCertificateRegistrationUrlResponse#

사업자 인증서 등록 URL 조회

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyCertificateRegistrationUrlError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_b2b_counterparty_certificate_registration_url_async(*, brn: str, test: bool | None = None) → GetB2bCounterpartyCertificateRegistrationUrlResponse#

사업자 인증서 등록 URL 조회

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyCertificateRegistrationUrlError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

validate_b2b_counterparty_certificate(*, brn: str, test: bool | None = None) → ValidateB2bCounterpartyCertificateResponse#

사업자 인증서 유효성 검증

연동 사업자가 등록한 인증서의 유효성을 검증합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

ValidateB2bCounterpartyCertificateError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async validate_b2b_counterparty_certificate_async(*, brn: str, test: bool | None = None) → ValidateB2bCounterpartyCertificateResponse#

사업자 인증서 유효성 검증

연동 사업자가 등록한 인증서의 유효성을 검증합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

ValidateB2bCounterpartyCertificateError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_b2b_counterparty_certificate(*, brn: str, test: bool | None = None) → B2bCertificate#

인증서 조회

연동 사업자의 인증서를 조회합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyCertificateError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_b2b_counterparty_certificate_async(*, brn: str, test: bool | None = None) → B2bCertificate#

인증서 조회

연동 사업자의 인증서를 조회합니다.

Parameters:

brn (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyCertificateError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_b2b_counterparty(*, counterparty_id: str, test: bool | None = None) → B2bCounterparty#

거래처 조회

거래처를 조회합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None) → B2bCounterparty#

거래처 조회

거래처를 조회합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

GetB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

delete_b2b_counterparty(*, counterparty_id: str, test: bool | None = None) → DeleteB2bCounterpartyResponse#

거래처 삭제

거래처를 삭제합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

DeleteB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async delete_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None) → DeleteB2bCounterpartyResponse#

거래처 삭제

거래처를 삭제합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

DeleteB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

update_b2b_counterparty(*, counterparty_id: str, test: bool | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → UpdateB2bCounterpartyResponse#

거래처 정보 수정

거래처 정보를 수정합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
counterparty (B2bCounterpartyInput) – 거래처 정보
options (B2bCounterpartyCreateOptions, optional) –
확인 옵션

사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Raises:

UpdateB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async update_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → UpdateB2bCounterpartyResponse#

거래처 정보 수정

거래처 정보를 수정합니다.

Parameters:

counterparty_id (str) – 거래처 ID
test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
counterparty (B2bCounterpartyInput) – 거래처 정보
options (B2bCounterpartyCreateOptions, optional) –
확인 옵션

사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Raises:

UpdateB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_b2b_counterparties(*, test: bool | None = None, page: PageInput | None = None, filter: B2bCounterpartyFilter | None = None) → GetB2bCounterpartiesResponse#

거래처 검색

거래처를 검색합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
page (PageInput, optional) – 페이지 정보
filter (B2bCounterpartyFilter, optional) – 검색 필터

Raises:

GetB2bCounterpartiesError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_b2b_counterparties_async(*, test: bool | None = None, page: PageInput | None = None, filter: B2bCounterpartyFilter | None = None) → GetB2bCounterpartiesResponse#

거래처 검색

거래처를 검색합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
page (PageInput, optional) – 페이지 정보
filter (B2bCounterpartyFilter, optional) – 검색 필터

Raises:

GetB2bCounterpartiesError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

create_b2b_counterparty(*, test: bool | None = None, counterparty_id: str | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → CreateB2bCounterpartyResponse#

거래처 생성

거래처를 생성합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
counterparty_id (str, optional) –
거래처 아이디

입력하지 않으면 임의의 ID가 채번됩니다.
counterparty (B2bCounterpartyInput) – 거래처 정보
options (B2bCounterpartyCreateOptions, optional) – 거래처 생성 옵션

Raises:

CreateB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async create_b2b_counterparty_async(*, test: bool | None = None, counterparty_id: str | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → CreateB2bCounterpartyResponse#

거래처 생성

거래처를 생성합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.
counterparty_id (str, optional) –
거래처 아이디

입력하지 않으면 임의의 ID가 채번됩니다.
counterparty (B2bCounterpartyInput) – 거래처 정보
options (B2bCounterpartyCreateOptions, optional) – 거래처 생성 옵션

Raises:

CreateB2bCounterpartyError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

portone_server_sdk.b2b.counterparty

Contents

portone_server_sdk.b2b.counterparty#