Invoice

Invoice is a React Component for displaying the invoice section on the orders sideview

Source:

Extends

Members

(inner) Button

Button component used for payment buttons

.

Source:

Button component used for payment buttons

(inner) canMakeAdjustments

A boolean indicating whether adjustments could be made on total payment

.

Source:

A boolean indicating whether adjustments could be made on total payment

(inner) components

If you've set up a components context using @reactioncommerce/components-context (recommended), then this prop will come from there automatically.

Source:

If you've set up a components context using @reactioncommerce/components-context (recommended), then this prop will come from there automatically. If you have not set up a components context or you want to override one of the components in a single spot, you can pass in the components prop directly.

(inner) currency

Currency details for the current shop

.

Source:

Currency details for the current shop

(inner) discounts

A boolean indicating whether discounts are enabled

.

Source:

A boolean indicating whether discounts are enabled

(inner) displayMedia

Function that renders media

.

Source:

Function that renders media

(inner) invoice

An order invoice document

.

Source:

An order invoice document

(inner) isCapturing

Set true when currently capturing a payment

.

Source:

Set true when currently capturing a payment

(inner) isFetching

Is the refund list being loaded

.

Source:

Is the refund list being loaded

(inner) isRefunding

True while a refund is being created

.

Source:

True while a refund is being created

(inner) moment

Injected MomentJS library

.

Source:

Injected MomentJS library

(inner) onApprovePayment

Function to be called when "Approve" is clicked for a payment

.

Source:

Function to be called when "Approve" is clicked for a payment

(inner) onCancelOrder

Function to be called when "Cancel Order" is clicked

.

Source:

Function to be called when "Cancel Order" is clicked

(inner) onCapturePayment

Function to be called when "Capture" is clicked for a payment

.

Source:

Function to be called when "Capture" is clicked for a payment

(inner) onRefundPayment

Function to be called when a refund is requested for a payment

.

Source:

Function to be called when a refund is requested for a payment

(inner) order

An order document

.

Source:

An order document

(inner) paymentMethods

List of payment methods defined for the shop that owns this order

.

Source:

List of payment methods defined for the shop that owns this order

(inner) printOrder

A string representing the route/path for printed order

.

Source:

A string representing the route/path for printed order

(inner) refunds

A list of refunds for this payment

.

Source:

A list of refunds for this payment

Methods

(inner) formatDate(context, block) → {String}

Formats dates

Source:
Parameters:
Name Type Description
context Number

the date to be formatted

block String

the preferred format

Returns:

formatted date

Type
String

(inner) handleClick(event) → {null}

Handle clicking the add discount link

Source:
Parameters:
Name Type Description
event Event

the event that fired

Returns:

null

Type
null

(inner) renderDiscountForm() → {null}

Displays the discount form

Source:
Returns:

null

Type
null

(inner) renderInvoice() → {null}

Displays the invoice form with broken down payment info

Source:
Returns:

null

Type
null

(inner) renderRefundsInfo() → {null}

Displays the refund information after the order payment breakdown on the invoice

Source:
Returns:

null

Type
null

(inner) renderSurcharge() → {null}

Displays the surcharge amount from the invoice, if available

Source:
Returns:

null

Type
null

(inner) renderTotal() → {null}

Displays the total payment form

Source:
Returns:

null

Type
null