From 056d86ba6d541ede34f69fba95964fe414a2a565 Mon Sep 17 00:00:00 2001 From: Juan Carlos Ruiz Date: Sun, 24 Feb 2019 00:14:23 -0600 Subject: [PATCH] Add Adjustment documentation reference links This adds link references for some articles related to the adjustment documentation overview. --- .../developers/adjustments/overview.html.md | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/guides/source/developers/adjustments/overview.html.md b/guides/source/developers/adjustments/overview.html.md index 99125394023..e758c646183 100644 --- a/guides/source/developers/adjustments/overview.html.md +++ b/guides/source/developers/adjustments/overview.html.md @@ -5,13 +5,19 @@ taxes and promotions generate price adjustments. Adjustments can be either a positive or a negative amount. Adjustments values come from [adjustment sources](#adjustment-sources) (for -example, a tax rate or a promotion action), and they affect the total price -of an [adjustable](#adjustables) (an order, line item, or shipment). +example, a [tax rate][taxation] or a [promotion action][promotion actions]), and +they affect the total price of an [adjustable](#adjustables) +(an [order][orders], line item, or [shipment][shipments]). +[orders]: ../orders/overview.html +[promotion actions]: ../promotions/promotion-actions.html +[shipments]: ../shipments/overview.html +[taxation]: ../taxation/overview.html + Adjustments have the following attributes: - `adjustable_type` and `adjustable_id`: The object being adjusted. This object @@ -26,13 +32,11 @@ Adjustments have the following attributes: - `included`: If set to `true`, the adjustment amount is included in the final price of the object it is associated with. Otherwise, the adjustment is added to the total price. This property only applies to tax adjustments. See the - taxation documentation for more information. + [taxation][taxation] documentation for more information. - `finalized`: Indicates whether the adjustment is finalized. If set to `true`, then the adjustment is no longer automatically updated. - +[taxation]: ../taxation/overview.html ## Adjustment sources @@ -54,15 +58,14 @@ Note that tax adjustments may be treated differently than promotional adjustments in some circumstances: - By default, tax adjustments are always applied before promotional adjustments. - This is to comply with well-known tax regulations. See the taxation + This is to comply with well-known tax regulations. See the [taxation][taxation] documentation for more information. - Typically, an adjustment's value is added to the price of the object it is - associated with. However, value-added tax adjustments are already included in - the price and do not change any totals. + associated with. However, [value-added tax][value-added tax] adjustments are + already included in the price and do not change any totals. - +[taxation]: ../taxation/overview.html +[value-added tax]: ../taxation/overview.html#sales-tax-and-value-added-tax ## Adjustables @@ -109,13 +112,12 @@ For example, you can find all of the adjustments with an `eligible` value of - `charge`: Returns adjustments with a positive value. - `credit`: Returns adjustments with a negative value. - `is_included`: Returns adjustments that are included in the object's price. - Typically, only value-added tax adjustments have this value. + Typically, only [value-added tax][value-added tax] adjustments have this + value. - `additional`: Adjustments which modify the object's price. The default for all adjustments. - +[value-added tax]: ../taxation/overview.html#sales-tax-and-value-added-tax [rails-scopes]: http://guides.rubyonrails.org/active_record_querying.html#scopes