Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
Optional
options: { Optional
page?: PageInput요청할 페이지 정보
Optional
filter?: PlatformPartnerFilterInput조회할 파트너 조건 필터
파트너 생성
새로운 파트너를 생성합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformAccountVerificationAlreadyUsedError 파트너 계좌 검증 아이디를 이미 사용한 경우
Errors.PlatformAccountVerificationFailedError 파트너 계좌 인증이 실패한 경우
Errors.PlatformAccountVerificationNotFoundError 파트너 계좌 검증 아이디를 찾을 수 없는 경우
Errors.PlatformContractNotFoundError PlatformContractNotFoundError
Errors.PlatformCurrencyNotSupportedError 지원 되지 않는 통화를 선택한 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerIdAlreadyExistsError PlatformPartnerIdAlreadyExistsError
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
Optional
id?: string파트너에 부여할 고유 아이디
고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
파트너 법인명 혹은 이름
파트너 담당자 연락 정보
정산 계좌
파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.
기본 계약 아이디
이미 존재하는 계약 아이디를 등록해야 합니다.
Optional
memo?: string파트너에 대한 메모
총 256자까지 입력할 수 있습니다.
파트너에 부여할 태그 리스트
최대 10개까지 입력할 수 있습니다.
파트너 유형별 추가 정보
사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.
Optional
user사용자 정의 속성
파트너 조회
파트너 객체를 조회합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
조회하고 싶은 파트너 아이디
파트너 수정
주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformAccountVerificationAlreadyUsedError 파트너 계좌 검증 아이디를 이미 사용한 경우
Errors.PlatformAccountVerificationFailedError 파트너 계좌 인증이 실패한 경우
Errors.PlatformAccountVerificationNotFoundError 파트너 계좌 검증 아이디를 찾을 수 없는 경우
Errors.PlatformArchivedPartnerError 보관된 파트너를 업데이트하려고 하는 경우
Errors.PlatformContractNotFoundError PlatformContractNotFoundError
Errors.PlatformInsufficientDataToChangePartnerTypeError 파트너 타입 수정에 필요한 데이터가 부족한 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
업데이트할 파트너 아이디
Optional
name?: string파트너 법인명 혹은 이름
Optional
contact?: UpdatePlatformPartnerBodyContact파트너 담당자 연락 정보
Optional
account?: UpdatePlatformPartnerBodyAccount정산 계좌
Optional
default파트너에 설정된 기본 계약 아이디
Optional
memo?: string파트너에 대한 메모
Optional
tags?: string[]파트너의 태그 리스트
Optional
type?: UpdatePlatformPartnerBodyType파트너 유형별 정보
Optional
user사용자 정의 속성
파트너 다건 생성
새로운 파트너를 다건 생성합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformContractsNotFoundError PlatformContractsNotFoundError
Errors.PlatformCurrencyNotSupportedError 지원 되지 않는 통화를 선택한 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerIdsAlreadyExistError PlatformPartnerIdsAlreadyExistError
Errors.PlatformPartnerIdsDuplicatedError PlatformPartnerIdsDuplicatedError
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
생성할 파트너 리스트 정보
파트너 복원
주어진 아이디에 대응되는 파트너를 보관합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformCannotArchiveScheduledPartnerError 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
파트너 아이디
파트너 복원
주어진 아이디에 대응되는 파트너를 복원합니다.
Errors.ForbiddenError 요청이 거절된 경우
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
파트너 아이디
파트너 다건 조회
여러 파트너를 조회합니다.