Application Load
IInvoiceRefund
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IInvoiceRefundRefund of a customer payment.
src/lib/interfaces/orionplace/payments/IInvoice.tsexport interface IInvoiceRefund {
// Refund invoice ID.
id: number;
// Refunded amount by currency ID.
amount: ICurrencyAmounts;
// Refund state: `EInvoiceStatus` value and its localized text. A refund is
// paid when it is `EInvoiceStatus.COMPLETED`.
status: {
// Refund state as an `EInvoiceStatus` value.
int: EInvoiceStatus;
// Localized name of the refund state.
text: string;
};
// Date the refund was created.
dates: {
// Date and time the refund was created.
created: IApiDateTime;
};
// true when the money was returned to the account balance; false when it was
// returned through the payment method of the original payment.
to_balance: boolean;
// Provider transaction identifier of the refund; empty for a refund to the
// balance.
merchant_transaction_id: string;
// Comment attached to the refund; it can be empty and is returned in the
// language it was written in.
comment: string;
}