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

    Type Alias PartnerClient

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

    type PartnerClient = {
        getPlatformPartners: (
            options?: { page?: PageInput; filter?: PlatformPartnerFilterInput },
        ) => Promise<GetPlatformPartnersResponse>;
        createPlatformPartner: (
            options: {
                id?: string;
                name: string;
                contact: CreatePlatformPartnerBodyContact;
                account: CreatePlatformPartnerBodyAccount;
                defaultContractId: string;
                memo?: string;
                tags: string[];
                type: CreatePlatformPartnerBodyType;
                userDefinedProperties?: PlatformProperties;
            },
        ) => Promise<CreatePlatformPartnerResponse>;
        createPlatformPartners: (
            options: { partners: CreatePlatformPartnerBody[] },
        ) => Promise<CreatePlatformPartnersResponse>;
        connectBulkPartnerMemberCompany: (
            options?: { filter?: PlatformPartnerFilterInput },
        ) => Promise<ConnectBulkPartnerMemberCompanyResponse>;
        connectPartnerMemberCompany: (
            options: { id: string },
        ) => Promise<ConnectPartnerMemberCompanyResponse>;
        disconnectBulkPartnerMemberCompany: (
            options?: { filter?: PlatformPartnerFilterInput },
        ) => Promise<DisconnectBulkPartnerMemberCompanyResponse>;
        disconnectPartnerMemberCompany: (
            options: { id: string },
        ) => Promise<DisconnectPartnerMemberCompanyResponse>;
        getPlatformPartner: (options: { id: string }) => Promise<PlatformPartner>;
        updatePlatformPartner: (
            options: {
                id: string;
                name?: string;
                contact?: UpdatePlatformPartnerBodyContact;
                account?: UpdatePlatformPartnerBodyAccount;
                defaultContractId?: string;
                memo?: string;
                tags?: string[];
                type?: UpdatePlatformPartnerBodyType;
                userDefinedProperties?: PlatformProperties;
            },
        ) => Promise<UpdatePlatformPartnerResponse>;
        archivePlatformPartner: (
            options: { id: string },
        ) => Promise<ArchivePlatformPartnerResponse>;
        recoverPlatformPartner: (
            options: { id: string },
        ) => Promise<RecoverPlatformPartnerResponse>;
    }
    Index

    Properties

    getPlatformPartners createPlatformPartner createPlatformPartners connectBulkPartnerMemberCompany connectPartnerMemberCompany disconnectBulkPartnerMemberCompany disconnectPartnerMemberCompany getPlatformPartner updatePlatformPartner archivePlatformPartner recoverPlatformPartner

    Properties

    getPlatformPartners: (
        options?: { page?: PageInput; filter?: PlatformPartnerFilterInput },
    ) => Promise<GetPlatformPartnersResponse>

    파트너 다건 조회

    여러 파트너를 조회합니다.

    GetPlatformPartnersError

    createPlatformPartner: (
        options: {
            id?: string;
            name: string;
            contact: CreatePlatformPartnerBodyContact;
            account: CreatePlatformPartnerBodyAccount;
            defaultContractId: string;
            memo?: string;
            tags: string[];
            type: CreatePlatformPartnerBodyType;
            userDefinedProperties?: PlatformProperties;
        },
    ) => Promise<CreatePlatformPartnerResponse>

    파트너 생성

    새로운 파트너를 생성합니다.

    CreatePlatformPartnerError

    createPlatformPartners: (
        options: { partners: CreatePlatformPartnerBody[] },
    ) => Promise<CreatePlatformPartnersResponse>

    파트너 다건 생성

    새로운 파트너를 다건 생성합니다.

    CreatePlatformPartnersError

    connectBulkPartnerMemberCompany: (
        options?: { filter?: PlatformPartnerFilterInput },
    ) => Promise<ConnectBulkPartnerMemberCompanyResponse>

    파트너 일괄 국세청 연동

    파트너들을 일괄 국세청 연동합니다.

    ConnectBulkPartnerMemberCompanyError

    connectPartnerMemberCompany: (
        options: { id: string },
    ) => Promise<ConnectPartnerMemberCompanyResponse>

    파트너 국세청 연동

    파트너를 국세청 연동합니다.

    ConnectPartnerMemberCompanyError

    disconnectBulkPartnerMemberCompany: (
        options?: { filter?: PlatformPartnerFilterInput },
    ) => Promise<DisconnectBulkPartnerMemberCompanyResponse>

    파트너 일괄 국세청 연동 해제

    파트너들을 일괄 국세청 연동 해제합니다.

    DisconnectBulkPartnerMemberCompanyError

    disconnectPartnerMemberCompany: (
        options: { id: string },
    ) => Promise<DisconnectPartnerMemberCompanyResponse>

    파트너 국세청 연동 해제

    파트너를 국세청 연동 해제합니다.

    DisconnectPartnerMemberCompanyError

    getPlatformPartner: (options: { id: string }) => Promise<PlatformPartner>

    파트너 조회

    파트너 객체를 조회합니다.

    GetPlatformPartnerError

    updatePlatformPartner: (
        options: {
            id: string;
            name?: string;
            contact?: UpdatePlatformPartnerBodyContact;
            account?: UpdatePlatformPartnerBodyAccount;
            defaultContractId?: string;
            memo?: string;
            tags?: string[];
            type?: UpdatePlatformPartnerBodyType;
            userDefinedProperties?: PlatformProperties;
        },
    ) => Promise<UpdatePlatformPartnerResponse>

    파트너 수정

    주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.

    UpdatePlatformPartnerError

    archivePlatformPartner: (
        options: { id: string },
    ) => Promise<ArchivePlatformPartnerResponse>

    파트너 보관

    주어진 아이디에 대응되는 파트너를 보관합니다.

    ArchivePlatformPartnerError

    recoverPlatformPartner: (
        options: { id: string },
    ) => Promise<RecoverPlatformPartnerResponse>

    파트너 복원

    주어진 아이디에 대응되는 파트너를 복원합니다.

    RecoverPlatformPartnerError

    Settings

    Member Visibility

    On This Page

    Properties