지급 내역 관련 API
파트너 정산 서비스의 지급 내역과 관련된 API 입니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행
은행
CompletePlatformPayoutByPartnerSettlementIdsBody: { bulkPayoutId, name, partnerSettlementIds, ... }
CompletePlatformPayoutByPartnerSettlementIdsBody
CompletePlatformPayoutByPartnerSettlementIdsError: | | | ...
CompletePlatformPayoutByPartnerSettlementIdsError
CompletePlatformPayoutByPartnerSettlementIdsResponse: { bulkPayoutId, bulkPayoutGraphqlId, payoutCount, ... }
일괄 지급 완료 처리 결과
일괄 지급 완료 처리 결과
Currency: "KRW" | "USD" | "JPY" | ...
통화 단위
통화 단위
DateTimeRange: { from, until }
시간 범위
시간 범위
ForbiddenError: { type, message }
요청이 거절된 경우
요청이 거절된 경우
GetPlatformPayoutsBody: { isForTest, page, filter }
GetPlatformPayoutsBody
GetPlatformPayoutsError: | | | ...
GetPlatformPayoutsError
GetPlatformPayoutsResponse: { items, page, counts }
GetPlatformPayoutsResponse
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
다건 조회 API 에 사용되는 페이지 입력 정보
PlatformAccount: { bank, currency, number, ... }
플랫폼 정산 계좌
currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.
PlatformAccountStatus: "VERIFIED" | "VERIFY_FAILED" | "VERIFY_ERROR" | ...
플랫폼 계좌 상태
플랫폼 계좌 상태
PlatformBulkPayoutIdAlreadyExistsError: { type, message }
일괄 지급 아이디가 이미 존재하는 경우
일괄 지급 아이디가 이미 존재하는 경우
PlatformContact: { name, phoneNumber, email }
플랫폼 파트너 담당자 연락 정보
파트너 담당자에게 연락하기 위한 정보들 입니다.
PlatformDuplicatedPartnerSettlementIdsError: { type, message }
선택된 정산건 아이디에 중복이 있는 경우
선택된 정산건 아이디에 중복이 있는 경우
PlatformNegativePayoutAmountPartnersError: { type, message }
지급 금액의 총합이 음수인 파트너가 존재하는 경우
지급 금액의 총합이 음수인 파트너가 존재하는 경우
PlatformNoSelectedPartnerSettlementsError: { type, message }
선택된 정산건이 없는 경우
선택된 정산건이 없는 경우
PlatformNonPayablePartnerSettlementsError: { type, ids, graphqlIds, ... }
지급할 수 없는 정산건이 포함된 경우
지급할 수 없는 정산건이 포함된 경우
PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartner: { id, graphqlId, name, ... }
파트너
파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.
PlatformPartnerBusinessStatus: "NOT_VERIFIED" | "VERIFY_ERROR" | "NOT_FOUND" | ...
플랫폼 파트너 사업자 상태
플랫폼 파트너 사업자 상태
PlatformPartnerMemberCompanyConnectionStatus: "NOT_CONNECTED" | "CONNECT_PENDING" | "CONNECTED" | ...
플랫폼 파트너 연동 사업자 연결 상태
플랫폼 파트너 연동 사업자 연결 상태
PlatformPartnerSettlementsNotFoundError: { type, ids, graphqlIds, ... }
요청한 정산건 목록을 찾을 수 없는 경우
요청한 정산건 목록을 찾을 수 없는 경우
PlatformPartnerStatus: "PENDING" | "APPROVED" | "REJECTED"
플랫폼 파트너 상태
플랫폼 파트너 상태
PlatformPartnerTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 파트너 과세 유형
플랫폼 파트너 과세 유형
PlatformPartnerType: | |
파트너 유형별 추가 정보
파트너 유형별 추가 정보
PlatformPartnerTypeBusiness: { type, companyName, taxationType, ... }
사업자 파트너 정보
사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeName: "BUSINESS" | "WHT_PAYER" | "NON_WHT_PAYER"
플랫폼 파트너 유형 이름
플랫폼 파트너 유형 이름
PlatformPartnerTypeNonWhtPayer: { type, birthdate }
원천징수 비대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeWhtPayer: { type, birthdate }
원천징수 대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPayout: { id, graphqlId, bulkPayoutId, ... }
PlatformPayout
PlatformPayoutAccount: { bank, number, holder }
PlatformPayoutAccount
PlatformPayoutFilterInput: { statuses, partnerIds, criteria, ... }
지급 내역 필터 입력 정보
지급 내역 필터 입력 정보
PlatformPayoutFilterInputCriteria: { timestampRange, statusUpdatedTimestampRange, scheduledTimestampRange, ... }
검색 기준 입력 정보
검색 기준 입력 정보
PlatformPayoutMethod: "DIRECT" | "AGENCY"
PlatformPayoutMethod
PlatformPayoutSettlementStatementStatus: "UNSENT" | "SENT" | "SEND_FAILED" | ...
정산 내역서 발송 상태
정산 내역서 발송 상태
PlatformPayoutSettlementStatementSummary: { status, id, issuedAt }
정산 내역서 요약 정보
정산 내역서 요약 정보
PlatformPayoutStatus: "CONFIRMED" | "PREPARED" | "CANCELLED" | ...
PlatformPayoutStatus
PlatformPayoutStatusStats: { confirmed, prepared, cancelled, ... }
PlatformPayoutStatusStats
PlatformPayoutTaxInvoiceStatus: "NONE" | "DRAFTED" | "DRAFT_PENDING" | ...
PlatformPayoutTaxInvoiceStatus
PlatformProperties: { [key: string]: }
PlatformProperties
PlatformUserDefinedPropertyValue: { string }
PlatformUserDefinedPropertyValue
SettlementAmountType: "NET" | "GROSS"
SettlementAmountType