Package-level declarations

Types

추가 수수료 정책 예약 업데이트 취소 성공 응답

Link copied to clipboard

계약 예약 업데이트 취소 성공 응답

할인 분담 정책 예약 업데이트 취소 성공 응답

Link copied to clipboard
@Serializable
data object CancelPlatformPartnerScheduleResponse

파트너 예약 업데이트 취소 성공 응답

Link copied to clipboard
@Serializable
data class DateRange(val from: String, val until: String)
Link copied to clipboard
@Serializable
data class MonthDay(val month: Int, val day: Int)

월 및 일자 정보

Link copied to clipboard
@Serializable
data class Platform(val merchantId: String, val graphqlId: String, val roundType: PlatformRoundType, val settlementFormula: PlatformSettlementFormula, val settlementRule: PlatformSettlementRule)

고객사의 플랫폼 기능 관련 정보

Link copied to clipboard
@Serializable
data class PlatformAccount(val bank: Bank, val currency: Currency, val number: String, val holder: String, val status: PlatformAccountStatus)

플랫폼 정산 계좌

Link copied to clipboard

플랫폼 계좌 상태

Link copied to clipboard
@Serializable
data class PlatformAdditionalFeePolicy(val id: String, val graphqlId: String, val name: String, val fee: PlatformFee, val vatPayer: PlatformPayer, val isArchived: Boolean, val appliedAt: @Serializable(with = InstantSerializer::class) Instant, val memo: String? = null)

추가 수수료 정책

Link copied to clipboard
Link copied to clipboard
@Serializable
data class PlatformContact(val name: String, val email: String, val phoneNumber: String? = null)

플랫폼 파트너 담당자 연락 정보

Link copied to clipboard
@Serializable
data class PlatformContract(val id: String, val graphqlId: String, val name: String, val platformFee: PlatformFee, val settlementCycle: PlatformSettlementCycle, val platformFeeVatPayer: PlatformPayer, val subtractPaymentVatAmount: Boolean, val isArchived: Boolean, val appliedAt: @Serializable(with = InstantSerializer::class) Instant, val memo: String? = null)

계약

Link copied to clipboard
@Serializable
data class PlatformDiscountSharePolicy(val id: String, val graphqlId: String, val name: String, val partnerShareRate: Int, val isArchived: Boolean, val appliedAt: @Serializable(with = InstantSerializer::class) Instant, val memo: String? = null)

할인 분담 정책

Link copied to clipboard
@Serializable
data class PlatformDiscountSharePolicyFilterOptions(val partnerShareRates: IntArray)

할인 분담 정책 필터 옵션 조회 성공 응답 정보

Link copied to clipboard
@Serializable
sealed interface PlatformFee

플랫폼 중개수수료 정보

Link copied to clipboard
@Serializable
data class PlatformFeeInput(val fixedRate: Int? = null, val fixedAmount: Long? = null)

수수료 계산 방식을 특정하기 위한 입력 정보

Link copied to clipboard
@Serializable
@SerialName(value = "FIXED_AMOUNT")
data class PlatformFixedAmountFee(val amount: Long) : PlatformFee

정액 수수료

Link copied to clipboard
@Serializable
@SerialName(value = "FIXED_RATE")
data class PlatformFixedRateFee(val rate: Int) : PlatformFee

정률 수수료

Link copied to clipboard
@Serializable
data class PlatformOrderSettlementAmount(val settlement: Long, val payment: Long, val paymentVat: Long, val paymentVatBurden: Long, val taxFree: Long, val supply: Long, val paymentTaxFree: Long, val paymentSupply: Long, val order: Long, val orderTaxFree: Long, val platformFee: Long, val platformFeeVat: Long, val additionalFee: Long, val additionalFeeVat: Long, val discount: Long, val discountTaxFree: Long, val discountShare: Long, val discountShareTaxFree: Long)

정산 금액 정보

Link copied to clipboard
@Serializable
data class PlatformPartner(val id: String, val graphqlId: String, val name: String, val contact: PlatformContact, val account: PlatformAccount, val status: PlatformPartnerStatus, val defaultContractId: String, val tags: List<String>, val type: PlatformPartnerType, val isArchived: Boolean, val appliedAt: @Serializable(with = InstantSerializer::class) Instant, val userDefinedProperties: PlatformProperties, val memo: String? = null)

파트너

Link copied to clipboard

플랫폼 파트너 사업자 상태

Link copied to clipboard
@Serializable
data class PlatformPartnerContractSummary(val id: String, val name: String)

파트너 계약 요약 정보

Link copied to clipboard
@Serializable
data class PlatformPartnerFilterInput(val isArchived: Boolean? = null, val tags: List<String>? = null, val banks: List<Bank>? = null, val accountCurrencies: List<Currency>? = null, val ids: List<String>? = null, val contractIds: List<String>? = null, val keyword: PlatformPartnerFilterInputKeyword? = null)

파트너 필터 입력 정보

Link copied to clipboard
@Serializable
data class PlatformPartnerFilterInputKeyword(val id: String? = null, val name: String? = null, val email: String? = null, val businessRegistrationNumber: String? = null, val defaultContractId: String? = null, val memo: String? = null, val accountNumber: String? = null, val accountHolder: String? = null)

파트너 검색 키워드 입력 정보

Link copied to clipboard
@Serializable
data class PlatformPartnerFilterOptions(val tags: List<String>, val contractSummary: List<PlatformPartnerContractSummary>)

파트너 필터 옵션 조회 성공 응답 정보

Link copied to clipboard

플랫폼 파트너 상태

Link copied to clipboard

플랫폼 파트너 과세 유형

Link copied to clipboard
@Serializable
sealed interface PlatformPartnerType

파트너 유형별 추가 정보

Link copied to clipboard
@Serializable
@SerialName(value = "BUSINESS")
data class PlatformPartnerTypeBusiness(val companyName: String, val taxationType: PlatformPartnerTaxationType, val businessStatus: PlatformPartnerBusinessStatus, val businessRegistrationNumber: String, val representativeName: String, val companyAddress: String? = null, val businessType: String? = null, val businessClass: String? = null) : PlatformPartnerType

사업자 파트너 정보

Link copied to clipboard
@Serializable
@SerialName(value = "NON_WHT_PAYER")
data class PlatformPartnerTypeNonWhtPayer(val birthdate: String? = null) : PlatformPartnerType

원천징수 비대상자 파트너 정보

Link copied to clipboard
@Serializable
@SerialName(value = "WHT_PAYER")
data class PlatformPartnerTypeWhtPayer(val birthdate: String? = null) : PlatformPartnerType

원천징수 대상자 파트너 정보

Link copied to clipboard
@Serializable
enum PlatformPayer : Enum<PlatformPayer>

금액 부담 주체

Link copied to clipboard
Link copied to clipboard
@Serializable
data class PlatformPayoutStatusStats(val prepared: Long, val cancelled: Long, val stopped: Long, val processing: Long, val succeeded: Long, val failed: Long, val scheduled: Long)
Link copied to clipboard
@Serializable
data class PlatformProperties(val string: String)
Link copied to clipboard

금액에 대한 소수점 처리 방식

Link copied to clipboard
@Serializable
data class PlatformSettlementCycle(val lagDays: Int, val datePolicy: PlatformSettlementCycleDatePolicy, val method: PlatformSettlementCycleMethod)

정산 주기

Link copied to clipboard

플랫폼 정산 기준일

Link copied to clipboard
@Serializable
data class PlatformSettlementCycleInput(val lagDays: Int, val datePolicy: PlatformSettlementCycleDatePolicy, val method: PlatformSettlementCycleMethodInput)

플랫폼 정산 주기 입력 정보

Link copied to clipboard
@Serializable
sealed interface PlatformSettlementCycleMethod

플랫폼 정산 주기 계산 방식

Link copied to clipboard
@Serializable
@SerialName(value = "DAILY")
data object PlatformSettlementCycleMethodDaily : PlatformSettlementCycleMethod

매일 정산

Link copied to clipboard
Link copied to clipboard

플랫폼 정산 주기 계산 방식 입력 정보

Link copied to clipboard
@Serializable
@SerialName(value = "MANUAL_DATES")
data class PlatformSettlementCycleMethodManualDates(val dates: List<MonthDay>) : PlatformSettlementCycleMethod

정해진 날짜(월, 일)에 정산

Link copied to clipboard
@Serializable
@SerialName(value = "MONTHLY")
data class PlatformSettlementCycleMethodMonthly(val daysOfMonth: IntArray) : PlatformSettlementCycleMethod

매월 정해진 날(일)에 정산

@Serializable
data class PlatformSettlementCycleMethodMonthlyInput(val daysOfMonth: IntArray)
Link copied to clipboard
@Serializable
@SerialName(value = "WEEKLY")
data class PlatformSettlementCycleMethodWeekly(val daysOfWeek: List<DayOfWeek>) : PlatformSettlementCycleMethod

매주 정해진 요일에 정산

Link copied to clipboard
@Serializable
data class PlatformSettlementCycleMethodWeeklyInput(val daysOfWeek: List<DayOfWeek>)
Link copied to clipboard
@Serializable
data class PlatformSettlementFormula(val platformFee: String, val discountShare: String, val additionalFee: String)

플랫폼 내 발생하는 여러 수수료 및 할인 분담에 관한 계산식 정보

Link copied to clipboard
@Serializable
sealed interface PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
@SerialName(value = "INVALID_FUNCTION")
data class PlatformSettlementFormulaInvalidFunction(val name: String, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
@SerialName(value = "INVALID_OPERATOR")
data class PlatformSettlementFormulaInvalidOperator(val operator: String, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
@SerialName(value = "INVALID_SYNTAX")
data class PlatformSettlementFormulaInvalidSyntax(val syntax: String, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
@SerialName(value = "INVALID_VARIABLE")
data class PlatformSettlementFormulaInvalidVariable(val name: String, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
data class PlatformSettlementFormulaPosition(val startLine: Int, val startIndex: Int, val endLine: Int, val endIndex: Int)
@Serializable
@SerialName(value = "UNEXPECTED_FUNCTION_ARGUMENTS")
data class PlatformSettlementFormulaUnexpectedFunctionArguments(val functionName: String, val expectedCount: Int, val currentCount: Int, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
@SerialName(value = "UNKNOWN_ERROR")
data object PlatformSettlementFormulaUnknownError : PlatformSettlementFormulaError
@Serializable
@SerialName(value = "UNSUPPORTED_VARIABLE")
data class PlatformSettlementFormulaUnsupportedVariable(val name: String, val position: PlatformSettlementFormulaPosition) : PlatformSettlementFormulaError
Link copied to clipboard
@Serializable
data class PlatformSettlementRule(val supportsMultipleOrderTransfersPerPartner: Boolean, val adjustSettlementDateAfterHolidayIfEarlier: Boolean, val subtractWhtInPayoutAmount: Boolean)

플랫폼 정산건 처리 방식에 관한 규칙

Link copied to clipboard
@Serializable
data class PlatformUserDefinedPropertyValue(val string: String)
@Serializable
data class ReschedulePlatformAdditionalFeePolicyResponse(val scheduledAdditionalFeePolicy: PlatformAdditionalFeePolicy)

추가 수수료 정책 예약 업데이트 재설정 성공 응답

Link copied to clipboard
@Serializable
data class ReschedulePlatformContractResponse(val scheduledContract: PlatformContract)

계약 예약 업데이트 재설정 성공 응답

@Serializable
data class ReschedulePlatformDiscountSharePolicyResponse(val scheduledDiscountSharePolicy: PlatformDiscountSharePolicy)

할인 분담 정책 예약 업데이트 재설정 성공 응답

Link copied to clipboard
@Serializable
data class ReschedulePlatformPartnerResponse(val scheduledPartner: PlatformPartner)

파트너 예약 업데이트 재설정 성공 응답

@Serializable
data class SchedulePlatformAdditionalFeePolicyResponse(val scheduledAdditionalFeePolicy: PlatformAdditionalFeePolicy)

추가 수수료 정책 업데이트 예약 성공 응답

Link copied to clipboard
@Serializable
data class SchedulePlatformContractResponse(val scheduledContract: PlatformContract)

계약 업데이트 예약 성공 응답

@Serializable
data class SchedulePlatformDiscountSharePolicyResponse(val scheduledDiscountSharePolicy: PlatformDiscountSharePolicy)

할인 분담 정책 업데이트 예약 성공 응답

Link copied to clipboard
@Serializable
data class SchedulePlatformPartnerResponse(val scheduledPartner: PlatformPartner)

파트너 업데이트 예약 성공 응답

Link copied to clipboard
@Serializable
data class SchedulePlatformPartnersBodyUpdate(val name: String? = null, val contact: SchedulePlatformPartnersBodyUpdateContact? = null, val type: SchedulePlatformPartnersBodyUpdateType? = null, val account: SchedulePlatformPartnersBodyUpdateAccount? = null, val defaultContractId: String? = null, val memo: String? = null, val tags: List<String>? = null, val userDefinedProperties: PlatformProperties? = null)
@Serializable
data class SchedulePlatformPartnersBodyUpdateAccount(val bank: Bank, val currency: Currency, val number: String, val holder: String, val accountVerificationId: String? = null)

파트너 계좌 업데이트를 위한 입력 정보

@Serializable
data class SchedulePlatformPartnersBodyUpdateContact(val name: String? = null, val phoneNumber: String? = null, val email: String? = null)

파트너 업데이트를 위한 유형별 추가 정보

Link copied to clipboard

파트너 유형별 정보 업데이트를 위한 입력 정보

@Serializable
data class SchedulePlatformPartnersBodyUpdateTypeBusiness(val companyName: String? = null, val taxationType: PlatformPartnerTaxationType? = null, val businessRegistrationNumber: String? = null, val representativeName: String? = null, val companyAddress: String? = null, val businessType: String? = null, val businessClass: String? = null)
@Serializable
data class SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer(val birthdate: String? = null)
@Serializable
data class SchedulePlatformPartnersBodyUpdateTypeWhtPayer(val birthdate: String? = null)
Link copied to clipboard
@Serializable
data object SchedulePlatformPartnersResponse
Link copied to clipboard
@Serializable
data class UpdatePlatformAdditionalFeePolicyBody(val fee: PlatformFeeInput? = null, val name: String? = null, val memo: String? = null, val vatPayer: PlatformPayer? = null)

추가 수수료 정책 업데이트를 위한 입력 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformBodySettlementFormula(val platformFee: String? = null, val discountShare: String? = null, val additionalFee: String? = null)

플랫폼 업데이트 시 변경할 계산식 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformBodySettlementRule(val supportsMultipleOrderTransfersPerPartner: Boolean? = null, val adjustSettlementDateAfterHolidayIfEarlier: Boolean? = null, val subtractWhtInPayoutAmount: Boolean? = null)

플랫폼 업데이트 시 변경할 정산 규칙 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformContractBody(val name: String? = null, val memo: String? = null, val platformFee: PlatformFeeInput? = null, val settlementCycle: PlatformSettlementCycleInput? = null, val platformFeeVatPayer: PlatformPayer? = null, val subtractPaymentVatAmount: Boolean? = null)

계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다.

Link copied to clipboard
@Serializable
data class UpdatePlatformDiscountSharePolicyBody(val name: String? = null, val partnerShareRate: Int? = null, val memo: String? = null)

할인 분담 정책 업데이트를 위한 입력 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBody(val name: String? = null, val contact: UpdatePlatformPartnerBodyContact? = null, val account: UpdatePlatformPartnerBodyAccount? = null, val defaultContractId: String? = null, val memo: String? = null, val tags: List<String>? = null, val type: UpdatePlatformPartnerBodyType? = null, val userDefinedProperties: PlatformProperties? = null)

파트너 업데이트를 위한 입력 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyAccount(val bank: Bank, val currency: Currency, val number: String, val holder: String, val accountVerificationId: String? = null)

파트너 계좌 업데이트를 위한 입력 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyContact(val name: String? = null, val phoneNumber: String? = null, val email: String? = null)

파트너 담당자 업데이트를 위한 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyType(val business: UpdatePlatformPartnerBodyTypeBusiness? = null, val whtPayer: UpdatePlatformPartnerBodyTypeWhtPayer? = null, val nonWhtPayer: UpdatePlatformPartnerBodyTypeNonWhtPayer? = null)

파트너 업데이트를 위한 유형별 추가 정보

Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyTypeBusiness(val companyName: String? = null, val taxationType: PlatformPartnerTaxationType? = null, val businessRegistrationNumber: String? = null, val representativeName: String? = null, val companyAddress: String? = null, val businessType: String? = null, val businessClass: String? = null)
Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyTypeNonWhtPayer(val birthdate: String? = null)
Link copied to clipboard
@Serializable
data class UpdatePlatformPartnerBodyTypeWhtPayer(val birthdate: String? = null)
Link copied to clipboard
@Serializable
data class UpdatePlatformResponse(val platform: Platform)

플랫폼 업데이트 결과 정보