Storefront templates

Show a customer their account and what it owes, let the people who manage it set sublimits, and in order billing take payment of an order’s balance. The plugin does not ship storefront pages. You build them with craft.netTerms and two controller actions.

craft.netTerms returns only accounts the signed-in user can see: the holder’s, one they are an active buyer on, or one they can manage. Who can manage an account is the holder by default; see company accounts to change that.

getAccount() returns only the account the user holds or buys on. For someone who manages an account without buying on it, fetch the account with getAccountByHolderId(holderId).

Example#

1. Fetch the signed-in user’s account.
2. Show what it owes and what the user can still charge.
3. List its invoices with a link to each.

{% set account = craft.netTerms.getAccount() %}

{% if account %}
	{% set buyer = craft.netTerms.getCurrentBuyer(account) %}

	<p>Owed: {{ craft.netTerms.getOwed(account)|money }}</p>
	{% if buyer and buyer.active %}
		{% set available = craft.netTerms.getAvailableCredit(buyer) %}
		<p>Available to you: {{ available ? available|money : 'Unlimited' }}</p>
	{% endif %}

	{% for invoice in craft.netTerms.getInvoices(account) %}
		<a href="{{ siteUrl('account/invoice', { number: invoice.number }) }}">
			{{ invoice.number }}, due {{ invoice.dateDue|date('medium') }},
			{{ craft.netTerms.getInvoiceBalance(invoice)|money }}
		</a>
	{% endfor %}
{% endif %}

Amounts are Money objects. Format them with Craft’s |money filter.

Managing buyers#

To set a buyer’s sublimit, post to net-terms/storefront/save-buyer. To add a user as a buyer, send userId instead of buyerId. A blank sublimit means no sublimit. The action accepts any user unless a site module limits who; see events.

{% if craft.netTerms.canManage(account) %}
	{% for buyer in craft.netTerms.getBuyers(account) %}
		{% if buyer.active %}
			<form method="post">
				{{ csrfInput() }}
				{{ actionInput('net-terms/storefront/save-buyer') }}
				{{ redirectInput('account/net-terms') }}
				{{ hiddenInput('accountId', account.id) }}
				{{ hiddenInput('buyerId', buyer.id) }}
				<label>{{ buyer.getName() }}
					<input type="text" name="sublimit" value="{{ buyer.getSublimitNumber() }}">
				</label>
				<button type="submit">Save</button>
			</form>
		{% endif %}
	{% endfor %}
{% endif %}

To remove a buyer, post accountId and buyerId to net-terms/storefront/remove-buyer. The action deactivates a buyer with ledger entries or credit orders instead of removing them. Adding that user again reactivates them.

Both actions return a 403 for a user who can’t manage the account. When a sublimit doesn’t save, the action flashes the reason, such as a sublimit below what the buyer owes.

Order billing#

In order billing there are no invoices. List the account’s unpaid orders instead, each with its balance and due date. Check craft.netTerms.billing.value to build one template for either mode.

{% for order in craft.netTerms.getOrders(account, true) %}
	<a href="{{ siteUrl('account/net-terms-pay', { number: order.number }) }}">{{ order.reference }}</a>
	due {{ craft.netTerms.getOrderDateDue(order)|date('medium') }},
	{{ craft.netTerms.getOrderBalance(order)|money }}
{% endfor %}

Paying an order’s balance#

Pay a completed order’s balance with Commerce’s own commerce/payments/pay action, posting the order’s number and email, because it isn’t the session cart. Offer the gateways Commerce makes available for the order. The Net Terms gateway is never offered for a completed order. To choose which other gateways are, see billing by order.

{% set order = craft.orders.number(craft.app.request.getQueryParam('number')).one() %}
{% set balance = order ? craft.netTerms.getOrderBalance(order) : null %}

{% if balance and balance.isPositive() %}
	{% for gateway in craft.commerce.gateways.getAllCustomerEnabledGatewaysAndAvailableForUseWithOrder(order) %}
		<form method="post">
			{{ csrfInput() }}
			{{ actionInput('commerce/payments/pay') }}
			{{ redirectInput('account/net-terms') }}
			{{ hiddenInput('number', order.number) }}
			{{ hiddenInput('email', order.email) }}
			{{ hiddenInput('gatewayId', gateway.id) }}

			{% namespace gateway.handle|commercePaymentFormNamespace %}
				{{ gateway.getPaymentFormHtml({ order: order })|raw }}
			{% endnamespace %}
		</form>
	{% endfor %}
{% endif %}

This form charges the order’s whole balance. The payment is a Commerce transaction on the order, and the order’s balance and what the buyer owes go down by its amount. Net Terms does not record it as a payment.

To link order reminders to this page, set Storefront order path to its path, such as account/net-terms-pay?number={number}; see configuration.

craft.netTerms#

For an account the user can’t see, methods return null, false, or an empty array. Because getAvailableCredit() also returns null for unlimited credit, check that the user can see the account first, such as with buyer and buyer.active.