@portone/server-sdk
    Preparing search index...

    Type Alias CounterpartyClient

    포트원 API 클라이언트를 생성합니다.

    type CounterpartyClient = {
        getB2bCounterpartyCertificateRegistrationUrl: (
            options: { brn: string; test?: boolean },
        ) => Promise<GetB2bCounterpartyCertificateRegistrationUrlResponse>;
        validateB2bCounterpartyCertificate: (
            options: { brn: string; test?: boolean },
        ) => Promise<ValidateB2bCounterpartyCertificateResponse>;
        getB2bCounterpartyCertificate: (
            options: { brn: string; test?: boolean },
        ) => Promise<B2bCertificate>;
        getB2bCounterparty: (
            options: { counterpartyId: string; test?: boolean },
        ) => Promise<B2bCounterparty>;
        deleteB2bCounterparty: (
            options: { counterpartyId: string; test?: boolean },
        ) => Promise<DeleteB2bCounterpartyResponse>;
        updateB2bCounterparty: (
            options: {
                counterpartyId: string;
                test?: boolean;
                counterparty: B2bCounterpartyInput;
                options?: B2bCounterpartyCreateOptions;
            },
        ) => Promise<UpdateB2bCounterpartyResponse>;
        getB2bCounterparties: (
            options?: {
                test?: boolean;
                page?: PageInput;
                filter?: B2bCounterpartyFilter;
            },
        ) => Promise<GetB2bCounterpartiesResponse>;
        createB2bCounterparty: (
            options: {
                test?: boolean;
                counterpartyId?: string;
                counterparty: B2bCounterpartyInput;
                options?: B2bCounterpartyCreateOptions;
            },
        ) => Promise<CreateB2bCounterpartyResponse>;
    }
    Index

    Properties

    getB2bCounterpartyCertificateRegistrationUrl: (
        options: { brn: string; test?: boolean },
    ) => Promise<GetB2bCounterpartyCertificateRegistrationUrlResponse>

    사업자 인증서 등록 URL 조회

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

    GetB2bCounterpartyCertificateRegistrationUrlError

    validateB2bCounterpartyCertificate: (
        options: { brn: string; test?: boolean },
    ) => Promise<ValidateB2bCounterpartyCertificateResponse>

    사업자 인증서 유효성 검증

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

    ValidateB2bCounterpartyCertificateError

    getB2bCounterpartyCertificate: (
        options: { brn: string; test?: boolean },
    ) => Promise<B2bCertificate>

    인증서 조회

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

    GetB2bCounterpartyCertificateError

    getB2bCounterparty: (
        options: { counterpartyId: string; test?: boolean },
    ) => Promise<B2bCounterparty>

    거래처 조회

    거래처를 조회합니다.

    GetB2bCounterpartyError

    deleteB2bCounterparty: (
        options: { counterpartyId: string; test?: boolean },
    ) => Promise<DeleteB2bCounterpartyResponse>

    거래처 삭제

    거래처를 삭제합니다.

    DeleteB2bCounterpartyError

    updateB2bCounterparty: (
        options: {
            counterpartyId: string;
            test?: boolean;
            counterparty: B2bCounterpartyInput;
            options?: B2bCounterpartyCreateOptions;
        },
    ) => Promise<UpdateB2bCounterpartyResponse>

    거래처 정보 수정

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

    UpdateB2bCounterpartyError

    getB2bCounterparties: (
        options?: {
            test?: boolean;
            page?: PageInput;
            filter?: B2bCounterpartyFilter;
        },
    ) => Promise<GetB2bCounterpartiesResponse>

    거래처 검색

    거래처를 검색합니다.

    GetB2bCounterpartiesError

    createB2bCounterparty: (
        options: {
            test?: boolean;
            counterpartyId?: string;
            counterparty: B2bCounterpartyInput;
            options?: B2bCounterpartyCreateOptions;
        },
    ) => Promise<CreateB2bCounterpartyResponse>

    거래처 생성

    거래처를 생성합니다.

    CreateB2bCounterpartyError