Skip to content

Commit

Permalink
style: Updated readme and fixed typo in workspace.
Browse files Browse the repository at this point in the history
  • Loading branch information
GichanaMayaka committed May 12, 2024
1 parent dfc1a09 commit eba5a3d
Show file tree
Hide file tree
Showing 15 changed files with 99 additions and 41 deletions.
60 changes: 59 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ The fields present include:

![Environment Settings Next Tab](/kenya_compliance/docs/images/environment_settings_page_2.PNG)

The additional Settings tab offers options to customise the frequency of communication to the eTims Servers. Choosing hourly implies information will be batched, and sent on an hourly basis. Possible options include: _Immediately_, _Half-Hourly_, _Hourly_, and _Daily_
<a id="submission_frequency"></a>

The additional Settings tab offers options to customise the frequency of communication to the eTims Servers. Choosing hourly implies information will be batched, and sent on an hourly basis. Possible options include: _All_, _Hourly_, _Daily_, as well as the possibility of adding custom configurations through the _Cron_ option among others.

To learn more about Cron, and how to specify Cron Expression, [Click here](https://en.wikipedia.org/wiki/Cron).

**NOTE**: The communication key is stored in this doctype, and it's fetched immediately one tries to save a record. If all information is valid, a valid key will be issued and stored which is used for all subsequent communication. If the key was not fetched, one cannot proceed to save the record as that will impose an inconsistent state upon the system. **The key is only issued once. In the event of loosing it, one has to liaise with KRA to regenerate a new key**.

Expand Down Expand Up @@ -186,6 +190,60 @@ For each item, the above fields are required in order to submit sales informatio

POS Invoice customisations also reflect the changes such as Sales Invoice, with the same behavior for the items, as well as submission.

### Stock Movements

<a id="stock_movements"></a>

Transactions that affect stock levels are automatically submitted to the eTims Servers.

Submission of Stock Movements is achieved by sending Stock Ledger Entry records. The process has been automated through [Background Jobs](#background_jobs) to relieve users from having to manually submit Stock Balance (inventory) information, as well as changes in stocks.

The frequency of submission can be customised from the relevant settings record, under the [Submission Frequency Settings](#submission_frequency) tab.

**NOTE**: Only Stockable Items are submitted to eTims Servers.

### Fetching Purchases

<a id="registered_purchases"></a>

Users are able to fetch Sales details registered by other Parties that form the basis for Purchase Documents.

![Registered Purchases](/kenya_compliance/docs/images/registered_purchases.PNG)

Once the counter-party's sales information (your purchase) is successfully fetched, you can create Items, Suppliers, Purchase Invoices, and Purchase Receits from the details.

![Registered Purchases Actions](/kenya_compliance/docs/images/registered_purchases_actions.PNG)

**NOTE**: This feature is highly experimental and may result in discrepancies between the information fetched and the generated records, e.g. Tax Details after creating a Purchase Invoice.

### Branch Management

<a id="branch_management"></a>

![branch management](/kenya_compliance/docs/images/branch.PNG)

Managing Branches is achieved via mapping Warehouses to the Navari eTims Branch doctype on a one-to-one basis.

![warehouses](/kenya_compliance/docs/images/warehouse.PNG)

Mapping the Warehouses to the relevant branch ensures correct referencing of Branch Ids when submitting stock movement information.

### Imported Item Management

<a id="imported_item_management"></a>

![imported item management](/kenya_compliance/docs/images/fetching%20imported%20items.PNG)

The **Registered Imported Item** doctype allows one to fetch imported items declared to belong to the user's company. These Items can be of existing Items (items already in ERPNext's database) or new Items.

![imported item record view](/kenya_compliance/docs/images/imported%20item%20record%20view.PNG)

To link an Imported Item to an existing Item, you reference te Item in the _Referenced Imported Item_ field of Item doctype under the _Purchasing_ tab.

![linking item with imported item](/kenya_compliance/docs/images/linking%20imported%20item%20to%20item.PNG)

Once the records have been linked, the user can submit the _converted_ (specifying the item classification of the accepted imported item) back to eTims to register the item. This is done through the _eTims Action, Submit Imported Item_ action button. This action button is active if the Item is linked to an Imported Item and the Item has not been registered prior.

## How to Install

<a id="installation"></a>
Expand Down
Binary file added kenya_compliance/docs/images/branch.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified kenya_compliance/docs/images/customer_doctype.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified kenya_compliance/docs/images/environment_settings.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified kenya_compliance/docs/images/environment_settings_page_2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified kenya_compliance/docs/images/routes_reference.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added kenya_compliance/docs/images/warehouse.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified kenya_compliance/docs/images/workspace.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -72,45 +72,6 @@
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "Branch and Users",
"link_count": 3,
"link_type": "DocType",
"onboard": 0,
"type": "Card Break"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "eTims Branche",
"link_count": 0,
"link_to": "Navari eTims Branch",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "eTims User",
"link_count": 0,
"link_to": "Navari eTims User",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "Warehouse",
"link_count": 0,
"link_to": "Warehouse",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
Expand Down Expand Up @@ -308,9 +269,48 @@
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "Branch and Users",
"link_count": 3,
"link_type": "DocType",
"onboard": 0,
"type": "Card Break"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "eTims Branch",
"link_count": 0,
"link_to": "Navari eTims Branch",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "eTims User",
"link_count": 0,
"link_to": "Navari eTims User",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
},
{
"hidden": 0,
"is_query_report": 0,
"label": "Warehouse",
"link_count": 0,
"link_to": "Warehouse",
"link_type": "DocType",
"onboard": 0,
"type": "Link"
}
],
"modified": "2024-05-09 13:29:36.963021",
"modified": "2024-05-12 14:31:49.327510",
"modified_by": "Administrator",
"module": "Kenya Compliance",
"name": "eTims Integration",
Expand Down

0 comments on commit eba5a3d

Please sign in to comment.