Skip to main content

Refund

Refund​

@vendure/corerefund.entity.ts

A refund the belongs to an order

Signature
class Refund extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<Refund>)
    @Money() items: number;
    @Money() shipping: number;
    @Money() adjustment: number;
    @Money() total: number;
    @Column() method: string;
    @Column({ nullable: true }) reason: string;
    @Column('varchar') state: RefundState;
    @Column({ nullable: true }) transactionId: string;
    @OneToMany(type => RefundLine, line => line.refund)
    @JoinTable()
    lines: RefundLine[];
    @Index()
    @ManyToOne(type => Payment, payment => payment.refunds)
    @JoinColumn()
    payment: Payment;
    @EntityId()
    paymentId: ID;
    @Column('simple-json') metadata: PaymentMetadata;
    @Column(type => CustomRefundFields)
    customFields: CustomRefundFields;
}

constructor​

method
(input?: DeepPartial<Refund>) => Refund

items​

property
number

shipping​

property
number

adjustment​

property
number

total​

property
number

method​

property
string

reason​

property
string

state​

property
RefundState

transactionId​

property
string

lines​

property
RefundLine[]

payment​

property
Payment

paymentId​

property
ID

metadata​

property
PaymentMetadata

customFields​

property
CustomRefundFields