Skip to content
This repository has been archived by the owner on Nov 30, 2017. It is now read-only.

Commit

Permalink
[Taxation] Update model, interface
Browse files Browse the repository at this point in the history
  • Loading branch information
tuka217 committed Dec 10, 2015
1 parent 6791b72 commit 880201d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
8 changes: 4 additions & 4 deletions components/Taxation/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Basic Usage
Tax Rate
--------

Every tax rate has two identifiers, an ID and name. You can access those by calling ``->getId()`` and ``getName()``
respectively. The name is mutable, so you can change it by calling ``->setName('EU VAT')`` on the tax rate instance.
Every tax rate has three identifiers, an ID, code and name. You can access those by calling ``->getId()``, ``->getCode()`` and ``getName()``
respectively. The name and code are mutable, so you can change them by calling ``->setCode('X12XW')`` and ``->setName('EU VAT')`` on the tax rate instance.

Setting Tax Amount
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -63,8 +63,8 @@ should be the same as name of your calculator object.
Tax Category
------------

Every tax category has two identifiers, an ID and name. You can access those by calling ``->getId()`` and ``getName()``
respectively. The name is mutable, so you can change it by calling ``->setName('Clothing')`` on the tax category instance.
Every tax category has three identifiers, an ID, code and name. You can access those by calling ``->getId()``, ``->getCode()`` and ``getName()``
respectively. The code and name are mutable, so you can change them by calling ``->setCode('X12X')`` and ``->setName('Clothing')`` on the tax category instance.

Tax Rate Management
~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions components/Taxation/interfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To create object which provides information about tax category, the object class
**TaxCategoryInterface**.

.. note::
This interface extends :ref:`component_resource_model_timestampable-interface`. |br|
This interface extends :ref:`component_resource_model_code-aware-interface` and :ref:`component_resource_model_timestampable-interface`. |br|
For more detailed information go to `Sylius API's Tax Category Interface`_.

.. _Sylius API's Tax Category Interface: http://api.sylius.org/Sylius/Component/Taxation/Model/TaxCategoryInterface.html
Expand All @@ -34,7 +34,7 @@ To create object which provides information about tax rate, the object class nee
**TaxCategoryInterface**.

.. note::
This interface extends :ref:`component_resource_model_timestampable-interface`. |br|
This interface extends :ref:`component_resource_model_code-aware-interface` and :ref:`component_resource_model_timestampable-interface`. |br|
For more detailed information go to `Sylius API's Tax Rate Interface`_.

.. _Sylius API's Tax Rate Interface: http://api.sylius.org/Sylius/Component/Taxation/Model/TaxCategoryInterface.html
Expand Down
4 changes: 4 additions & 0 deletions components/Taxation/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Tax rate model holds the configuration for particular tax rate.
+=================+====================================+
| id | Unique id of the tax rate |
+-----------------+------------------------------------+
| code | Unique code of the tax rate |
+-----------------+------------------------------------+
| category | Tax rate category |
+-----------------+------------------------------------+
| name | Name of the rate |
Expand Down Expand Up @@ -39,6 +41,8 @@ Tax category model holds the configuration for particular tax category.
+=================+========================================================+
| id | Unique id of the tax category |
+-----------------+--------------------------------------------------------+
| code | Unique code of the tax category |
+-----------------+--------------------------------------------------------+
| name | Name of the category |
+-----------------+--------------------------------------------------------+
| description | Description of tax category |
Expand Down

0 comments on commit 880201d

Please sign in to comment.