@portone/server-sdk/dist/generated/platform/transfer/PlatformOrderTransfer.d.ts

PortOne JavaScript SDK for server-side usage

import type { Currency } from "./../../common/Currency.js";
import type { PlatformContract } from "./../../platform/PlatformContract.js";
import type { PlatformOrderSettlementAmount } from "./../../platform/PlatformOrderSettlementAmount.js";
import type { PlatformOrderTransferAdditionalFee } from "./../../platform/transfer/PlatformOrderTransferAdditionalFee.js";
import type { PlatformOrderTransferDiscount } from "./../../platform/transfer/PlatformOrderTransferDiscount.js";
import type { PlatformOrderTransferOrderLine } from "./../../platform/transfer/PlatformOrderTransferOrderLine.js";
import type { PlatformPartner } from "./../../platform/PlatformPartner.js";
import type { PlatformPayment } from "./../../platform/transfer/PlatformPayment.js";
import type { PlatformTransferStatus } from "./../../platform/transfer/PlatformTransferStatus.js";
import type { PlatformUserDefinedPropertyKeyValue } from "./../../platform/transfer/PlatformUserDefinedPropertyKeyValue.js";
import type { TransferParameters } from "./../../platform/transfer/TransferParameters.js";
/** 주문 정산건 */
export type PlatformOrderTransfer = {
    type: "ORDER";
    /** 정산건 아이디 */
    id: string;
    graphqlId: string;
    /** 파트너 */
    partner: PlatformPartner;
    /** 정산 상태 */
    status: PlatformTransferStatus;
    /** 메모 */
    memo?: string;
    /**
     * 정산 일
     *
     * 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다.
     * (yyyy-MM-dd)
     */
    settlementDate: string;
    /** 정산 통화 */
    settlementCurrency: Currency;
    payoutId?: string;
    payoutGraphqlId?: string;
    /** 테스트 모드 여부 */
    isForTest: boolean;
    /** 사용자 정의 속성 */
    userDefinedProperties: PlatformUserDefinedPropertyKeyValue[];
    /** 정산 금액 정보 */
    amount: PlatformOrderSettlementAmount;
    /** 계약 */
    contract: PlatformContract;
    /** 결제 정보 */
    payment: PlatformPayment;
    /**
     * 정산 시작일
     *
     * 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다.
     * (yyyy-MM-dd)
     */
    settlementStartDate: string;
    /** 주문 항목 리스트 */
    orderLines: PlatformOrderTransferOrderLine[];
    /** 정산 금액 계산 시 사용된 추가 수수료 정보 */
    additionalFees: PlatformOrderTransferAdditionalFee[];
    /** 정산 금액 계산 시 사용된 할인 정보 */
    discounts: PlatformOrderTransferDiscount[];
    /** 정산 파라미터 (실험기능) */
    parameters: TransferParameters;
};