개발자센터

파트너 관련 API

파트너 정산에 적용할 파트너에 관한 API 입니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
ArchivePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledPartnerError | ...
ArchivePlatformPartnerResponse: { partner }
파트너 보관 성공 응답
Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행
ConnectBulkPartnerCounterpartyBody: { filter }
파트너 일괄 거래처 연동 요청 정보

파트너들을 일괄 거래처 연동합니다.

ConnectBulkPartnerCounterpartyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
ConnectBulkPartnerCounterpartyResponse: { bulkTask }
파트너 일괄 거래처 연동 응답
ConnectPartnerCounterpartyError: ForbiddenError | InvalidRequestError | PlatformArchivedPartnerError | ...
ConnectPartnerCounterpartyResponse: { partner }
파트너 거래처 연동 응답
CreatePlatformPartnerBody: { id, name, contact, ... }
파트너 생성을 위한 입력 정보
CreatePlatformPartnerBodyAccount: { bank, currency, number, ... }
파트너 계좌 등록을 위한 정보
CreatePlatformPartnerBodyContact: { name, phoneNumber, email }
파트너 담당자 정보
CreatePlatformPartnerBodyType: { business, whtPayer, nonWhtPayer }
파트너 생성을 위한 유형별 추가 정보
CreatePlatformPartnerBodyTypeBusiness: { companyName, taxationType, businessRegistrationNumber, ... }
CreatePlatformPartnerBodyTypeNonWhtPayer: { birthdate }
CreatePlatformPartnerBodyTypeWhtPayer: { birthdate }
CreatePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformAccountVerificationAlreadyUsedError | ...
CreatePlatformPartnerResponse: { partner }
파트너 생성 성공 응답
CreatePlatformPartnersBody: { partners }
파트너 다건 생성을 위한 입력 정보
CreatePlatformPartnersError: ForbiddenError | InvalidRequestError | PlatformContractsNotFoundError | ...
CreatePlatformPartnersResponse: { partners }
파트너 다건 생성 성공 응답
Currency: "KRW" | "USD" | "JPY" | ...
통화
DisconnectBulkPartnerCounterpartyBody: { filter }
파트너 일괄 거래처 연동 해제 요청 정보

파트너들을 일괄 거래처 연동 해제합니다.

DisconnectBulkPartnerCounterpartyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
DisconnectBulkPartnerCounterpartyResponse: { bulkTask }
파트너 일괄 거래처 연동 해제 응답
DisconnectPartnerCounterpartyError: ForbiddenError | InvalidRequestError | PlatformArchivedPartnerNtsNotAllowedError | ...
DisconnectPartnerCounterpartyResponse: { partner }
파트너 거래처 연동 해제 응답
ForbiddenError: { type, message }
요청이 거절된 경우
GetPlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPartnersBody: { page, filter }
파트너 다건 조회를 위한 입력 정보
GetPlatformPartnersError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPartnersResponse: { items, page }
파트너 다건 조회 성공 응답 정보
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

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

PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PlatformAccount: { bank, currency, number, ... }
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

PlatformAccountStatus: "VERIFIED" | "VERIFY_FAILED" | "VERIFY_ERROR" | ...
플랫폼 계좌 상태
PlatformAccountVerificationAlreadyUsedError: { type, message }
파트너 계좌 검증 아이디를 이미 사용한 경우
PlatformAccountVerificationFailedError: { type, message }
파트너 계좌 인증이 실패한 경우
PlatformAccountVerificationNotFoundError: { type, message }
파트너 계좌 검증 아이디를 찾을 수 없는 경우
PlatformArchivedPartnerError: { type, message }
보관된 파트너를 업데이트하려고 하는 경우
PlatformArchivedPartnerNtsNotAllowedError: { type, message }
보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우
PlatformBtxNotEnabledError: { type, message }
BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformBulkTask: { id, graphqlId, status, ... }
PlatformBulkTaskProgressStats: { preparedCount, processingCount, succeededCount, ... }
PlatformBulkTaskStatus: "PREPARED" | "PROCESSING" | "COMPLETED" | ...
PlatformBulkTaskType: "CREATE_TRANSFERS" | "CREATE_PARTNERS" | "CONNECT_MEMBER_COMPANIES" | ...
PlatformCannotArchiveScheduledPartnerError: { type, message }
예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
PlatformCompanyVerificationAlreadyUsedError: { type, message }
파트너 사업자 검증 아이디를 이미 사용한 경우
PlatformContact: { name, phoneNumber, email }
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

PlatformContractNotFoundError: { type, message }
PlatformContractsNotFoundError: { type, ids, graphqlIds, ... }
PlatformCounterpartyNotConnectableStatusError: { type, message }
파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우
PlatformCounterpartyNotConnectedError: { type, message }
파트너가 거래처로 연동 되어있지 않은 경우
PlatformCounterpartyOngoingTaxInvoiceExistsError: { type, message }
연동된 거래처에 진행 중인 세금계산서가 있는 경우
PlatformCurrencyNotSupportedError: { type, message }
지원 되지 않는 통화를 선택한 경우
PlatformExternalApiFailedError: { type, message }
외부 api 오류
PlatformInsufficientDataToChangePartnerTypeError: { type, message }
파트너 타입 수정에 필요한 데이터가 부족한 경우
PlatformMemberCompanyConnectedPartnerBrnUnchangeableError: { type, message }
연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우
PlatformMemberCompanyConnectedPartnerTypeUnchangeableError: { type, message }
연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우
PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformOngoingTaxInvoiceExistsError: { type, message }
진행 중인 세금계산서가 존재하는 경우
PlatformPartner: { id, graphqlId, name, ... }
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

PlatformPartnerBusinessStatus: "NOT_VERIFIED" | "VERIFY_ERROR" | "NOT_FOUND" | ...
플랫폼 파트너 사업자 상태
PlatformPartnerFilterInput: { isArchived, tags, banks, ... }
파트너 필터 입력 정보
PlatformPartnerFilterInputKeyword: { id, name, email, ... }
파트너 검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformPartnerIdAlreadyExistsError: { type, message }
PlatformPartnerIdsAlreadyExistError: { type, ids, graphqlIds, ... }
PlatformPartnerIdsDuplicatedError: { type, ids, graphqlIds, ... }
PlatformPartnerMemberCompanyConnectionStatus: "NOT_CONNECTED" | "CONNECT_PENDING" | "CONNECTED" | ...
플랫폼 파트너 연동 사업자 연결 상태
PlatformPartnerNotFoundError: { type, message }
PlatformPartnerPendingNtsOperationError: { type, message }
파트너의 국세청 연동/해제가 진행 중인 경우
PlatformPartnerScheduleExistsError: { type, message }
파트너 수정 예약 건이 존재하는 경우
PlatformPartnerStatus: "PENDING" | "APPROVED" | "REJECTED"
플랫폼 파트너 상태
PlatformPartnerTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 파트너 과세 유형
PlatformPartnerTaxationTypeIsSimpleError: { type, message }
파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우
PlatformPartnerType: PlatformPartnerTypeBusiness | PlatformPartnerTypeNonWhtPayer | PlatformPartnerTypeWhtPayer
파트너 유형별 추가 정보
PlatformPartnerTypeBusiness: { type, companyName, taxationType, ... }
사업자 파트너 정보

사업자 유형의 파트너 추가 정보 입니다.

PlatformPartnerTypeIsNotBusinessError: { type, message }
파트너 유형이 사업자가 아닌 경우
PlatformPartnerTypeName: "BUSINESS" | "WHT_PAYER" | "NON_WHT_PAYER"
플랫폼 파트너 유형 이름
PlatformPartnerTypeNonWhtPayer: { type, birthdate }
원천징수 비대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

PlatformPartnerTypeWhtPayer: { type, birthdate }
원천징수 대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

PlatformProperties: { [key: string]: PlatformUserDefinedPropertyValue }
PlatformTargetPartnerNotFoundError: { type, message }
처리 대상 파트너가 존재하지 않는 경우
PlatformUserDefinedPropertyNotFoundError: { type, message }
사용자 정의 속성이 존재 하지 않는 경우
PlatformUserDefinedPropertyValue: { string }
RecoverPlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
RecoverPlatformPartnerResponse: { partner }
파트너 복원 성공 응답
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우
UpdatePlatformPartnerBody: { name, contact, account, ... }
파트너 업데이트를 위한 입력 정보

값이 명시되지 않은 필드는 업데이트되지 않습니다.

UpdatePlatformPartnerBodyAccount: { bank, currency, number, ... }
파트너 계좌 업데이트를 위한 입력 정보
UpdatePlatformPartnerBodyContact: { name, phoneNumber, email }
파트너 담당자 업데이트를 위한 정보
UpdatePlatformPartnerBodyType: { business, whtPayer, nonWhtPayer }
파트너 업데이트를 위한 유형별 추가 정보

파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.

UpdatePlatformPartnerBodyTypeBusiness: { companyName, taxationType, businessRegistrationNumber, ... }
UpdatePlatformPartnerBodyTypeNonWhtPayer: { birthdate }
UpdatePlatformPartnerBodyTypeWhtPayer: { birthdate }
UpdatePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformAccountVerificationAlreadyUsedError | ...
UpdatePlatformPartnerResponse: { partner }
파트너 업데이트 성공 응답