정산 내역 관련 API
파트너 정산 서비스의 정산 내역과 관련된 API 입니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행
은행
Currency: "KRW" | "USD" | "JPY" | ...
통화 단위
통화 단위
DateRange: { from, until }
DateRange
DayOfWeek: "SUN" | "MON" | "TUE" | ...
요일
요일
DeletePlatformPartnerSettlementsError: | | | ...
DeletePlatformPartnerSettlementsError
DeletePlatformPartnerSettlementsResponse: { }
정산내역 삭제 결과
정산내역 삭제 결과
ForbiddenError: { type, message }
요청이 거절된 경우
요청이 거절된 경우
GetPlatformPartnerSettlementsError: | | | ...
GetPlatformPartnerSettlementsError
GetPlatformPartnerSettlementsResponse: { items, page, counts }
정산내역 다건 조회 성공 응답 정보
정산내역 다건 조회 성공 응답 정보
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MonthDay: { month, day }
월 및 일자 정보
월 및 일자 정보
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
다건 조회 API 에 사용되는 페이지 입력 정보
PlatformAccount: { bank, currency, number, ... }
플랫폼 정산 계좌
currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.
PlatformAccountStatus: "VERIFIED" | "VERIFY_FAILED" | "VERIFY_ERROR" | ...
플랫폼 계좌 상태
플랫폼 계좌 상태
PlatformContact: { name, phoneNumber, email }
플랫폼 파트너 담당자 연락 정보
파트너 담당자에게 연락하기 위한 정보들 입니다.
PlatformContract: { id, graphqlId, name, ... }
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
PlatformFee: |
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
PlatformFixedAmountFee: { type, amount }
정액 수수료
총 금액에 무관하게 정해진 수수료 금액을 책정합니다.
PlatformFixedRateFee: { type, rate }
정률 수수료
총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.
PlatformNonDeletablePartnerSettlementsError: { type, ids, graphqlIds, ... }
삭제할 수 없는 정산건이 포함된 경우
삭제할 수 없는 정산건이 포함된 경우
PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformOrderSettlementAmount: { settlement, settlementTaxFree, payment, ... }
정산 금액 정보
정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.
PlatformPartner: { id, graphqlId, name, ... }
파트너
파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.
PlatformPartnerBusinessStatus: "NOT_VERIFIED" | "VERIFY_ERROR" | "NOT_FOUND" | ...
플랫폼 파트너 사업자 상태
플랫폼 파트너 사업자 상태
PlatformPartnerManualSettlement: { type, id, graphqlId, ... }
PlatformPartnerManualSettlement
PlatformPartnerMemberCompanyConnectionStatus: "NOT_CONNECTED" | "CONNECT_PENDING" | "CONNECTED" | ...
플랫폼 파트너 연동 사업자 연결 상태
플랫폼 파트너 연동 사업자 연결 상태
PlatformPartnerOrderCancelSettlement: { type, id, graphqlId, ... }
PlatformPartnerOrderCancelSettlement
PlatformPartnerOrderSettlement: { type, id, graphqlId, ... }
PlatformPartnerOrderSettlement
PlatformPartnerSettlement: | |
PlatformPartnerSettlement
PlatformPartnerSettlementFilterInput: { settlementDates, contractIds, partnerTags, ... }
PlatformPartnerSettlementFilterInput
PlatformPartnerSettlementFilterKeywordInput: { partnerSettlementId, payoutId, bulkPayoutId }
PlatformPartnerSettlementFilterKeywordInput
PlatformPartnerSettlementStatus: "PAYOUT_SCHEDULED" | "PAYOUT_PREPARED" | "PAYOUT_WITHHELD" | ...
정산 상태
정산 상태
PlatformPartnerSettlementStatusStats: { payoutScheduled, payoutPrepared, payoutWithheld, ... }
PlatformPartnerSettlementStatusStats
PlatformPartnerSettlementType: "MANUAL" | "ORDER" | "ORDER_CANCEL"
정산 유형
정산 유형
PlatformPartnerSettlementsNotFoundError: { type, ids, graphqlIds, ... }
요청한 정산건 목록을 찾을 수 없는 경우
요청한 정산건 목록을 찾을 수 없는 경우
PlatformPartnerStatus: "PENDING" | "APPROVED" | "REJECTED"
플랫폼 파트너 상태
플랫폼 파트너 상태
PlatformPartnerTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 파트너 과세 유형
플랫폼 파트너 과세 유형
PlatformPartnerType: | |
파트너 유형별 추가 정보
파트너 유형별 추가 정보
PlatformPartnerTypeBusiness: { type, companyName, taxationType, ... }
사업자 파트너 정보
사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeNonWhtPayer: { type, birthdate }
원천징수 비대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeWhtPayer: { type, birthdate }
원천징수 대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPayer: "PARTNER" | "MERCHANT"
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PlatformProperties: { [key: string]: }
PlatformProperties
PlatformReferencedCancelOrderTransfersExistError: { type, ids, message }
취소 정산건이 참조 중인 정산건이 포함된 경우
취소 정산건이 참조 중인 정산건이 포함된 경우
PlatformSettlementCycle: { lagDays, datePolicy, method }
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
PlatformSettlementCycleDatePolicy: "HOLIDAY_BEFORE" | "HOLIDAY_AFTER" | "CALENDAR_DAY"
플랫폼 정산 기준일
플랫폼 정산 기준일
PlatformSettlementCycleMethod: | | | ...
플랫폼 정산 주기 계산 방식
플랫폼 정산 주기 계산 방식
PlatformSettlementCycleMethodDaily: { type }
매일 정산
매일 정산
PlatformSettlementCycleMethodManualDates: { type, dates }
정해진 날짜(월, 일)에 정산
정해진 날짜(월, 일)에 정산
PlatformSettlementCycleMethodMonthly: { type, daysOfMonth }
매월 정해진 날(일)에 정산
매월 정해진 날(일)에 정산
PlatformSettlementCycleMethodWeekly: { type, daysOfWeek }
매주 정해진 요일에 정산
매주 정해진 요일에 정산
PlatformUserDefinedFormulaResults: { [key: string]: integer (64 bit) }
PlatformUserDefinedFormulaResults
PlatformUserDefinedPropertyValue: { string }
PlatformUserDefinedPropertyValue