Difference between revisions of "Metrc Integration"
m (Admin moved page MetRC Integration to Metrc Integration: Change spelling: "MetRC" → "Metrc") |
|||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | [https://www.metrc.com/ ''' | + | [https://www.metrc.com/ '''Metrc'''] is a regulatory system for cannabis products adopted in many US states. |
− | From this article you can learn how to connect your HandiFox company with | + | From this article you can learn how to connect your HandiFox company with Metrc and how to work with cannabis products inside HandiFox. |
=== Setting up the Integration === | === Setting up the Integration === | ||
− | To initiate the integration, go to ''Integrations'' → ''All Add-ons'' and click ''Connect'' near the | + | To initiate the integration, go to ''Integrations'' → ''All Add-ons'' and click ''Connect'' near the Metrc logo. |
==== Initial steps ==== | ==== Initial steps ==== | ||
− | You will see the directions for generating an '''API key''' for your | + | You will see the directions for generating an '''API key''' for your Metrc account. Make sure you have a generated API key and click ''Next''. |
On the next screen, choose your state in the ''State'' field and paste your key in the ''User API Key'' field: | On the next screen, choose your state in the ''State'' field and paste your key in the ''User API Key'' field: | ||
Line 17: | Line 17: | ||
Click ''Next''. | Click ''Next''. | ||
− | On the next page you will need to define the initial settings for your connection with | + | On the next page you will need to define the initial settings for your connection with Metrc. There are quite a few settings here, so consult the descriptions below: |
==== Mapping inventory sites and facilities ==== | ==== Mapping inventory sites and facilities ==== | ||
− | ''Facilities'' are the | + | ''Facilities'' are the Metrc term for different physical locations where cannabis products can be stored or processed. |
− | At this point in the integration process, you have to '''set correspondence''' between your HandiFox ''sites'' and | + | At this point in the integration process, you have to '''set correspondence''' between your HandiFox ''sites'' and Metrc ''facilities''. Each facility can be mapped to one and only one HandiFox site. |
[[File:Metrc-connect-settings1.png]] | [[File:Metrc-connect-settings1.png]] | ||
Line 33: | Line 33: | ||
==== Mapping items ==== | ==== Mapping items ==== | ||
− | This section of the settings affects the treatment of new products downloaded by HandiFox from | + | This section of the settings affects the treatment of new products downloaded by HandiFox from Metrc. Here you can choose: |
* What prefix will be given to item names inside HandiFox in case of name collision. | * What prefix will be given to item names inside HandiFox in case of name collision. | ||
* The default asset, income and expense accounts for these new items. | * The default asset, income and expense accounts for these new items. | ||
Line 39: | Line 39: | ||
==== First synchronization settings ==== | ==== First synchronization settings ==== | ||
− | By default, old transfers and receipts will not be added to HandiFox from | + | By default, old transfers and receipts will not be added to HandiFox from Metrc. Here you can change that and specify the date range for which to download this data. |
− | ==== Mapping for transfers from | + | ==== Mapping for transfers from Metrc ==== |
− | This section affects how transfers from | + | This section affects how transfers from Metrc will be treated, and how inventory transfers in HandiFox will be sent to Metrc: |
<table style="border: 1px solid black; border-collapse: collapse;"> | <table style="border: 1px solid black; border-collapse: collapse;"> | ||
Line 54: | Line 54: | ||
<tr> | <tr> | ||
<td style="border: 1px solid black; padding: 3px;">Convert external outgoing transfers to...</td> | <td style="border: 1px solid black; padding: 3px;">Convert external outgoing transfers to...</td> | ||
− | <td style="border: 1px solid black; padding: 3px;">Which transaction type will be used to represent ''outgoing'' transfers created on the | + | <td style="border: 1px solid black; padding: 3px;">Which transaction type will be used to represent ''outgoing'' transfers created on the Metrc end.</td> |
</tr> | </tr> | ||
Line 64: | Line 64: | ||
<tr> | <tr> | ||
<td style="border: 1px solid black; padding: 3px;">Convert internal transfers to...</td> | <td style="border: 1px solid black; padding: 3px;">Convert internal transfers to...</td> | ||
− | <td style="border: 1px solid black; padding: 3px;">Which transaction type to use for sending transfers created ''in HandiFox'' to | + | <td style="border: 1px solid black; padding: 3px;">Which transaction type to use for sending transfers created ''in HandiFox'' to Metrc</td> |
</tr> | </tr> | ||
Line 71: | Line 71: | ||
==== Finishing the integration ==== | ==== Finishing the integration ==== | ||
− | When you are done with the settings, click Save. HandiFox will start its first synchronization with | + | When you are done with the settings, click Save. HandiFox will start its first synchronization with Metrc and display its progress. |
[[File:Metrc-connect-sync.png]] | [[File:Metrc-connect-sync.png]] | ||
− | When it completes, you will be left at the '' | + | When it completes, you will be left at the ''Metrc Panel'' page, which displays the current synchronization status. |
− | [[File:Metrc-panel.png|thumb|none|800px|The | + | [[File:Metrc-panel.png|thumb|none|800px|The Metrc Panel in the Web App]] |
Here you can also find a '''log''' of all synchronization events which you can search for clues in case of problems. | Here you can also find a '''log''' of all synchronization events which you can search for clues in case of problems. | ||
Line 83: | Line 83: | ||
You can click ''Settings'' to '''revisit the integration settings''' already described above and change them (except for the site-to-facility mapping which is irreversible). | You can click ''Settings'' to '''revisit the integration settings''' already described above and change them (except for the site-to-facility mapping which is irreversible). | ||
− | To access the | + | To access the Metrc Panel again later, go to ''Integrations'' → ''All Add-ons'' and click Panel near the Metrc logo. |
− | === | + | === Metrc Products Inside HandiFox === |
In HandiFox, cannabis products can be treated like normal items for inventory tracking purposes, which means you can edit their properties, assign barcodes to them, track their quantities across sites (including by lot number) , do inventory counts and so on. However, these items '''cannot be included on sales or purchase transactions'''. There are also some other differences which we will cover below. | In HandiFox, cannabis products can be treated like normal items for inventory tracking purposes, which means you can edit their properties, assign barcodes to them, track their quantities across sites (including by lot number) , do inventory counts and so on. However, these items '''cannot be included on sales or purchase transactions'''. There are also some other differences which we will cover below. | ||
Line 91: | Line 91: | ||
==== Item List ==== | ==== Item List ==== | ||
− | When viewing the properties of a cannabis product in the [[Products_and_Services#Managing_Products_and_Services | Item List]], you will see a '''new section''' dedicated to | + | When viewing the properties of a cannabis product in the [[Products_and_Services#Managing_Products_and_Services | Item List]], you will see a '''new section''' dedicated to Metrc-related information. |
[[File:Metrc-item-info.png]] | [[File:Metrc-item-info.png]] | ||
Line 101: | Line 101: | ||
: See also: [[Serial,_Lot_Number_and_Expiration_Date_Tracking | Serial, Lot Number and Expiration Date Tracking]] | : See also: [[Serial,_Lot_Number_and_Expiration_Date_Tracking | Serial, Lot Number and Expiration Date Tracking]] | ||
− | Upon addition to HandiFox, all | + | Upon addition to HandiFox, all Metrc products are set to be tracked ''by lot number''. Their ''Metrc package numbers'' are downloaded and stored in HandiFox as lot numbers. |
You can search and view inventory information (quantities, transactions) by lot number using the ''Serial/Lot Numbers'' page or the Transactions by Serial/Lot Number [[Reports | report]]. However, unlike with normal items, you cannot directly edit the lot numbers or lot quantities for cannabis items. | You can search and view inventory information (quantities, transactions) by lot number using the ''Serial/Lot Numbers'' page or the Transactions by Serial/Lot Number [[Reports | report]]. However, unlike with normal items, you cannot directly edit the lot numbers or lot quantities for cannabis items. | ||
Line 118: | Line 118: | ||
Cannabis counts also have other differences from regular counts: | Cannabis counts also have other differences from regular counts: | ||
− | * All packages are presented as a plain list, one package per line (rather | + | * All packages are presented as a plain list, one package per line (rather than one product per line). |
− | + | * Whenever there is a difference between the old and new quantity, you must choose a reason for this adjustment in the ''Adjustment Reason'' column. You also need to put in an explanatory note, if the chosen reason requires it. | |
− | * Whenever there is a difference between the old and new quantity, you must choose a reason for this adjustment in the ''Adjustment Reason'' column. You also need to put | ||
* If the quantity of a package changes to 0, you can mark is as ''finished'' with the corresponding checkbox. | * If the quantity of a package changes to 0, you can mark is as ''finished'' with the corresponding checkbox. |
Latest revision as of 14:39, 19 April 2020
Metrc is a regulatory system for cannabis products adopted in many US states.
From this article you can learn how to connect your HandiFox company with Metrc and how to work with cannabis products inside HandiFox.
Setting up the Integration
To initiate the integration, go to Integrations → All Add-ons and click Connect near the Metrc logo.
Initial steps
You will see the directions for generating an API key for your Metrc account. Make sure you have a generated API key and click Next.
On the next screen, choose your state in the State field and paste your key in the User API Key field:
Click Next.
On the next page you will need to define the initial settings for your connection with Metrc. There are quite a few settings here, so consult the descriptions below:
Mapping inventory sites and facilities
Facilities are the Metrc term for different physical locations where cannabis products can be stored or processed.
At this point in the integration process, you have to set correspondence between your HandiFox sites and Metrc facilities. Each facility can be mapped to one and only one HandiFox site.
If you don't have enough sites in HandiFox or would like to use an entirely separate set of sites for this, you can create more sites on the spot by clicking on the drop-down list in the HandiFox Inventory Site column and selecting Add New.
The Is Default column serves to indicate which facility is considered the default for licensing purposes in cases when one license covers multiple facilities. If this is not your case, just check every checkbox in this column.
Mapping items
This section of the settings affects the treatment of new products downloaded by HandiFox from Metrc. Here you can choose:
- What prefix will be given to item names inside HandiFox in case of name collision.
- The default asset, income and expense accounts for these new items.
First synchronization settings
By default, old transfers and receipts will not be added to HandiFox from Metrc. Here you can change that and specify the date range for which to download this data.
Mapping for transfers from Metrc
This section affects how transfers from Metrc will be treated, and how inventory transfers in HandiFox will be sent to Metrc:
Setting | Description |
---|---|
Convert external outgoing transfers to... | Which transaction type will be used to represent outgoing transfers created on the Metrc end. |
Converts external incoming transfers to... | The same, but for incoming transfers |
Convert internal transfers to... | Which transaction type to use for sending transfers created in HandiFox to Metrc |
Finishing the integration
When you are done with the settings, click Save. HandiFox will start its first synchronization with Metrc and display its progress.
When it completes, you will be left at the Metrc Panel page, which displays the current synchronization status.
Here you can also find a log of all synchronization events which you can search for clues in case of problems.
You can click Settings to revisit the integration settings already described above and change them (except for the site-to-facility mapping which is irreversible).
To access the Metrc Panel again later, go to Integrations → All Add-ons and click Panel near the Metrc logo.
Metrc Products Inside HandiFox
In HandiFox, cannabis products can be treated like normal items for inventory tracking purposes, which means you can edit their properties, assign barcodes to them, track their quantities across sites (including by lot number) , do inventory counts and so on. However, these items cannot be included on sales or purchase transactions. There are also some other differences which we will cover below.
Item List
When viewing the properties of a cannabis product in the Item List, you will see a new section dedicated to Metrc-related information.
It is also impossible to adjust the quantity of cannabis products inside HandiFox.
Serial/Lot Number Tracking
Upon addition to HandiFox, all Metrc products are set to be tracked by lot number. Their Metrc package numbers are downloaded and stored in HandiFox as lot numbers.
You can search and view inventory information (quantities, transactions) by lot number using the Serial/Lot Numbers page or the Transactions by Serial/Lot Number report. However, unlike with normal items, you cannot directly edit the lot numbers or lot quantities for cannabis items.
Inventory Counting
- See also: Inventory Counting.
When starting a new inventory count in HandiFox, you will need to choose whether you want to count regular products or cannabis products.
Regular products cannot be included on cannabis counting sessions and vice versa.
Cannabis counts also have other differences from regular counts:
- All packages are presented as a plain list, one package per line (rather than one product per line).
- Whenever there is a difference between the old and new quantity, you must choose a reason for this adjustment in the Adjustment Reason column. You also need to put in an explanatory note, if the chosen reason requires it.
- If the quantity of a package changes to 0, you can mark is as finished with the corresponding checkbox.