Record history fields
The entities and field keys of record history entries, per record type.
Each change entry of a record's history lists the rows an operation changed, each with its
entity, and each changed field by its key. This page lists, per record type, the entities
whose rows its history shows, and per entity the key, label and value type of each field. A
reference's value is the record's {id, name}, its name null once the record is gone or
archived, its id null for a menu buyer's user or locations; a list of references holds one
per record. An invoice or purchase payment,
as a reference, a row or the record a note was logged on, has its payment's ID, as
GET /public/v1/payments returns it (a deleted payment's too), null once no payment row is
left. A
field of keys (custom fields, permissions, a pricing tier's conditions, a test result's values)
changes as one field per key, its key <field>.<key>: custom_data.12 for custom field 12. A
payment, signature or harvest group saved with its invoice payment, purchase payment, signature
link or teardown shows in that row, its fields as its own entity lists them. Record types
marked "activity only" have no history of their own: their rows show in
GET /public/v1/activity. New fields can appear; a key never changes meaning.
Record types
| Record type | Rows its history shows |
|---|---|
ASSEMBLY | ASSEMBLY, ASSEMBLY_INPUT, ASSEMBLY_OUTPUT, ASSEMBLY_OUTPUT_BIN, TASK |
AUTOMATION | AUTOMATION, AUTOMATION_VERSION, RECURRING_SCHEDULE |
BATCH | BATCH, MATERIAL_TEST_RESULT, STOCK_ADJUSTMENT, TASK |
BIN | BIN |
CHARGE_PRESET | CHARGE_PRESET, CHARGE_PRESET_OWNER_TEAM, CHARGE_PRESET_OWNER_USER, CHARGE_PRESET_TAG |
COMPANY | ACCOUNT, COMPANY, CONTACT, LICENSE, LOCATION, PROFILE, TASK |
COMPANY_GROUP | COMPANY_GROUP |
COMPLIANCE_TRANSFER | COMPLIANCE_DELIVERY, COMPLIANCE_TRANSFER |
COST_TYPE | COST_TYPE |
CREDIT | CREDIT, CREDIT_USE |
CUSTOM_VALIDATION | CUSTOM_VALIDATION |
DATASET | CUSTOM_FIELD |
DRIVER | DRIVER |
HARVEST | HARVEST, HARVEST_WASTE |
INVITATION | INVITATION |
INVOICE | CHARGE, CREDIT_USE, INVOICE, INVOICE_ITEM, INVOICE_PAYMENT, INVOICE_RECIPIENT_EMAIL, ORDER_ITEM, PAYMENT, SIGNATURE, TASK |
LABEL_TEMPLATE | LABEL_TEMPLATE |
MENU | MENU, MENU_BANNER_IMAGE, MENU_COLLECTION, MENU_COLLECTION_BRAND, MENU_COLLECTION_IMAGE, MENU_COLLECTION_OFFICIAL_PRODUCT_CATEGORY, MENU_COLLECTION_PRODUCT_CATEGORY, MENU_COLLECTION_PRODUCT_GROUP, MENU_COLLECTION_PRODUCT_SUBCATEGORY, MENU_COLLECTION_STRAIN, MENU_COLLECTION_STRAIN_TYPE, MENU_HOLDER, MENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENT, MENU_OFFICIAL_PRODUCT_CATEGORY_TO_SELL_BY_POTENCY, MENU_PRODUCT, MENU_URL |
PACKAGE | MATERIAL_TEST_RESULT, PACKAGE, PACKAGE_BIN, STOCK_ADJUSTMENT |
PAYMENT_METHOD | PAYMENT_METHOD |
PAYMENT_TERM | PAYMENT_TERM |
PLANT | PLANT |
PLANT_ADDITIVE (activity only) | PLANT_ADDITIVE, PLANT_ADDITIVE_TARGET |
PLANT_ADDITIVE_TYPE (activity only) | PLANT_ADDITIVE_TYPE |
PLANT_GROUP | PLANT_GROUP |
PLANT_WASTE (activity only) | PLANT_WASTE, PLANT_WASTE_PLANT |
PRICE_TIER | MENU_PRICE_TIER, PRICE_TIER |
PRODUCT | PRODUCT, PRODUCT_TAG, STOCK_ADJUSTMENT, TASK |
PRODUCT_CATEGORY | PRODUCT_CATEGORY, PRODUCT_SUBCATEGORY |
PRODUCT_GROUP | PRODUCT_GROUP |
PURCHASE | CHARGE, ORDER_ITEM, PAYMENT, PURCHASE, PURCHASE_PAYMENT, TASK |
RELATIONSHIP_TYPE | RELATIONSHIP_TYPE |
RETURN | RETURN, RETURN_ITEM, TASK |
ROLE | ROLE |
SALES_ORDER | CHARGE, ORDER_ITEM, ORDER_SHIPMENT, ORDER_SHIPMENT_ITEM, SALES_ORDER, SIGNATURE, TASK |
SCHEDULED_ALERT | RECURRING_SCHEDULE, SCHEDULED_ALERT |
STOCK_TRANSFER | STOCK_TRANSFER, STOCK_TRANSFER_ITEM, TASK |
STRAIN | STRAIN |
TAG | TAG |
TAX | TAX, TAX_TAG |
TEAM | TEAM, TEAM_MEMBERSHIP |
TEARDOWN | HARVEST_GROUP, TEARDOWN, TEARDOWN_INPUT, TEARDOWN_MAPPING, TEARDOWN_OUTPUT |
TEST_RESULT | TEST_RESULT |
UNIT_TYPE | UNIT_TYPE |
USER | PROFILE, USER |
VEHICLE | VEHICLE |
Entities
ACCOUNT
Shown as "Company info".
| Key | Label | Type |
|---|---|---|
name | Name | string |
legal_business_name | Legal business name | string |
category | Category | string |
default_email | string | |
phone_number | Phone | string |
website | Website | string |
description | Description | string |
us_state | State | string |
instagram | string | |
facebook | string | |
twitter | string | |
weedmaps | Weedmaps | string |
leafly | Leafly | string |
default_sales_order_notes | Default sales order notes | string |
default_purchase_order_notes | Default purchase order notes | string |
ASSEMBLY
Shown as "Assembly".
| Key | Label | Type |
|---|---|---|
assembly_number | Assembly number | string |
description | Description | string |
status | Status | enum |
completion_datetime | Completed | datetime |
creation_source | Created from | enum |
license | License | reference to LICENSE |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
estimated_start_datetime | Estimated start | datetime |
estimated_work_total_minutes | Estimated work (minutes) | number |
metrc_processing_job_name | Metrc processing job | string |
metrc_processing_job_notes | Metrc processing job notes | string |
waste_count_quantity | Waste count | number |
waste_count_metrc_unit_name | Waste count unit | string |
waste_volume_quantity | Waste volume | number |
waste_volume_metrc_unit_name | Waste volume unit | string |
waste_weight_quantity | Waste weight | number |
waste_weight_metrc_unit_name | Waste weight unit | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
ASSEMBLY_INPUT
Shown as "Input".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
package | Package | reference to PACKAGE |
batch | Batch | reference to BATCH |
quantity | Quantity | number |
location | Location | reference to LOCATION |
inventory_user | Held by | reference to USER |
ASSEMBLY_OUTPUT
Shown as "Output".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
quantity | Quantity | number |
compliance_label | Metrc tag | string |
batch_number | Batch number | string |
metrc_production_batch_number | Production batch number | string |
is_production_batch | Production batch | boolean |
location | Location | reference to LOCATION |
inventory_user | Held by | reference to USER |
package_date | Package date | date |
manufactured_date | Manufactured date | date |
expiration_date | Expiration date | datetime |
bill_of_materials | Bill of materials | reference to BILL_OF_MATERIALS |
is_test_sample | Test sample | boolean |
is_trade_sample | Trade sample | boolean |
is_donation | Donation | boolean |
is_finished_good | Finished good | boolean |
copy_custom_data_from_input | Copy custom fields from input | boolean |
metrc_notes | Metrc notes | string |
lab_test_batches | Metrc lab test batches | list of strings |
biotrack_waste_quantity | Waste quantity | number |
biotrack_waste_unit_type | Waste unit | reference to UNIT_TYPE |
biotrack_lab_license_number | Lab license number | string |
biotrack_qa_sample_for_usable_cannabis | QA sample for usable cannabis | boolean |
biotrack_qa_sample_rnd | R&D sample | boolean |
ASSEMBLY_OUTPUT_BIN
Shown as "Output bin".
| Key | Label | Type |
|---|---|---|
bin | Bin | reference to BIN |
AUTOMATION
Shown as "Automation".
| Key | Label | Type |
|---|---|---|
name | Name | string |
description | Description | string |
trigger_type | Trigger | enum |
target_entity | Record type | enum |
trigger_operation | Runs on | enum |
current_version | Live version | reference to AUTOMATION_VERSION |
active | Active | boolean |
owner | Owner | reference to USER |
email_creator_on_failure | Email the creator on failure | boolean |
deleted_datetime | Deleted | datetime |
AUTOMATION_VERSION
Shown as "Version".
| Key | Label | Type |
|---|---|---|
version_number | Version | number |
BATCH
Shown as "Batch".
| Key | Label | Type |
|---|---|---|
name | Name | string |
batch_number | Batch number | string |
product | Product | reference to PRODUCT |
description | Description | string |
thc | THC | string |
cbd | CBD | string |
manufactured_datetime | Manufactured date | datetime |
harvest_datetime | Harvest date | datetime |
expiration_datetime | Expiration date | datetime |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
assembly | Assembly | reference to ASSEMBLY |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
deleted_at | Inactivated | datetime |
BIN
Shown as "Bin".
| Key | Label | Type |
|---|---|---|
name | Name | string |
CHARGE
Shown as "Charge".
| Key | Label | Type |
|---|---|---|
name | Name | string |
type | Type | string |
unit_type | Unit | enum |
percent | Percent | decimal (percent) |
price | Amount | decimal (dollars) |
tax | Tax | reference to TAX |
CHARGE_PRESET
Shown as "Charge preset".
| Key | Label | Type |
|---|---|---|
name | Name | string |
type | Type | string |
unit_type | Unit | enum |
percent | Percent | decimal (percent) |
price | Amount | decimal (dollars) |
auto_apply_tags_on_sales_orders | Automatically apply to sales orders | boolean |
auto_apply_tags_on_purchase_orders | Automatically apply to purchase orders | boolean |
allow_inline_edits | Allow inline editing | boolean |
quickbooks_sales_item | QuickBooks item (sales) | reference to QUICKBOOKS_ITEM |
quickbooks_purchase_item | QuickBooks item (purchases) | reference to QUICKBOOKS_ITEM |
CHARGE_PRESET_OWNER_TEAM
Shown as "Owner".
| Key | Label | Type |
|---|---|---|
team | Owner (team) | reference to TEAM |
CHARGE_PRESET_OWNER_USER
Shown as "Owner".
| Key | Label | Type |
|---|---|---|
user | Owner | reference to USER |
CHARGE_PRESET_TAG
Shown as "Tag".
| Key | Label | Type |
|---|---|---|
tag | Tag | reference to TAG |
COMPANY
Shown as "Company".
| Key | Label | Type |
|---|---|---|
owner | Owner | reference to USER |
relationship_type | Relationship type | reference to RELATIONSHIP_TYPE |
group | Company group | reference to COMPANY_GROUP |
account_number | Account number | string |
default_payment_term | Default payment term | reference to PAYMENT_TERM |
outstanding_balance_threshold | Balance threshold | decimal (dollars) |
default_inventory_location | Default inventory source (location) | reference to LOCATION |
default_inventory_user | Default inventory source (user) | reference to USER |
sales_order_email | Sales order email | string |
purchase_order_email | Purchase order email | string |
invoice_email | Invoice email | string |
order_shipment_email | Order shipment email | string |
document_address_display_name | Name on PDF addresses | enum |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
deleted_at | Deleted | datetime |
COMPANY_GROUP
Shown as "Company group".
| Key | Label | Type |
|---|---|---|
name | Name | string |
COMPLIANCE_DELIVERY
Shown as "Delivery".
| Key | Label | Type |
|---|---|---|
receiver_license_number | Receiver license | string |
receiver_license_name | Receiver | string |
shipment_type | Shipment type | enum |
departure_datetime | Departure | datetime |
arrival_datetime | Arrival | datetime |
driving_route | Route | string |
biotrack_arrived | Arrived | boolean |
compliance_received_datetime | Received | datetime |
biotrack_payment_status | Payment status | string |
biotrack_automatic_return_status | Automatic return | enum |
removed_datetime | Removed | datetime |
COMPLIANCE_TRANSFER
Shown as "Compliance transfer".
| Key | Label | Type |
|---|---|---|
manifest_number | Manifest number | string |
incoming | Incoming | boolean |
license | License | reference to LICENSE |
sender_license_number | Sender license | string |
sender_license_name | Sender | string |
driver | Driver | reference to DRIVER |
driver2 | Second driver | reference to DRIVER |
vehicle | Vehicle | reference to VEHICLE |
biotrack_driver_description | Transporter's driver | string |
biotrack_vehicle_description | Transporter's vehicle | string |
removed_datetime | Removed | datetime |
CONTACT
Shown as "Contact".
| Key | Label | Type |
|---|---|---|
company | Company | reference to COMPANY |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
driver_license_number | Driver license number | string |
driver_license_issuing_state | Driver license state | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
deleted_at | Deleted | datetime |
COST_TYPE
Shown as "Cost type".
| Key | Label | Type |
|---|---|---|
name | Name | string |
description | Description | string |
cost_per_unit | Cost per unit | decimal (dollars) |
unit_type | Unit type | reference to UNIT_TYPE |
allow_inline_edits | Allow inline cost editing | boolean |
active | Active | boolean |
deleted_at | Deleted | datetime |
CREDIT
Shown as "Credit".
| Key | Label | Type |
|---|---|---|
credit_number | Credit number | string |
amount | Amount | decimal (dollars) |
source | Source | enum |
company | Customer | reference to COMPANY |
brand | Brand | reference to COMPANY |
owner | Owner | reference to USER |
payment | Payment | reference to PAYMENT |
return | Return | reference to RETURN |
quickbooks_sales_item | QuickBooks sales item | reference to QUICKBOOKS_ITEM |
external_note | External note | string |
internal_note | Internal note | string |
canceled_datetime | Canceled | datetime |
deleted_datetime | Deleted | datetime |
deleted_in_qbo | Deleted in QuickBooks | boolean |
CREDIT_USE
Shown as "Credit use".
| Key | Label | Type |
|---|---|---|
credit | Credit | reference to CREDIT |
amount | Amount | decimal (dollars) |
deleted_datetime | Deleted | datetime |
CUSTOM_FIELD
Shown as "Custom field".
| Key | Label | Type |
|---|---|---|
name | Name | string |
field_type | Type | enum |
description | Description | string |
field_options | Options | list of strings |
disabled_field_options | Disabled options | list of strings |
required | Required | boolean |
filterable | Filterable | boolean |
CUSTOM_VALIDATION
Shown as "Custom validation".
| Key | Label | Type |
|---|---|---|
name | Name | string |
entity | Applies to | enum |
actions | When | enum |
condition | Condition | object |
message | Error message | string |
enabled | Enabled | boolean |
DRIVER
Shown as "Driver".
| Key | Label | Type |
|---|---|---|
first_name | First name | string |
last_name | Last name | string |
email | string | |
phone_number | Phone | string |
driver_license | Driver's license | string |
occupational_license_number | Occupational license | string |
birth_date | Birth date | date |
hire_date | Hire date | date |
us_state | State | string |
biotrack_vendor_license_number | Vendor license | string |
biotrack_qa_lab_license_number | Lab license | string |
creator | Created by | reference to USER |
deleted_datetime | Deleted | datetime |
HARVEST
Shown as "Harvest".
| Key | Label | Type |
|---|---|---|
name | Name | string |
metrc_strain_name | Strain | string |
harvested_datetime | Harvested on | datetime |
location | Location | reference to LOCATION |
license | License | reference to LICENSE |
unit_type | Unit | reference to UNIT_TYPE |
metrc_plant_count | Plant count | number |
finished_date | Finished | date |
removed_datetime | Removed | datetime |
HARVEST_GROUP
Shown as "Harvest group".
| Key | Label | Type |
|---|---|---|
name | Name | string |
grown_for | Grown for | reference to COMPANY |
HARVEST_WASTE
Shown as "Waste".
| Key | Label | Type |
|---|---|---|
waste_type | Type | string |
quantity | Quantity | number |
unit_type | Unit | reference to UNIT_TYPE |
waste_date | Date | date |
INVITATION
Shown as "Invitation".
| Key | Label | Type |
|---|---|---|
email | string | |
role | Role | reference to ROLE |
inviter | Invited by | reference to USER |
accepted | Accepted | boolean |
receiver | Accepted by | reference to USER |
create_user_in_biotrack | Create BioTrack user | boolean |
INVOICE
Shown as "Invoice".
| Key | Label | Type |
|---|---|---|
invoice_number | Invoice number | string |
status | Status | string |
invoice_datetime | Invoice date | datetime |
due_datetime | Due date | datetime |
payment_term_name | Payment terms | string |
total | Total | decimal (dollars) |
paid_amount | Paid | decimal (dollars) |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
billing_location | Billing location | reference to LOCATION |
order | Order | reference to SALES_ORDER |
external_notes | External notes | string |
internal_notes | Internal notes | string |
terms_and_services | Terms and services | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
pos_finalized_reason | POS sync stopped | enum |
deleted_in_qbo | Deleted in QuickBooks | boolean |
voided_datetime | Voided | datetime |
INVOICE_ITEM
Shown as "Line".
| Key | Label | Type |
|---|---|---|
quantity | Quantity | number |
description | Description | string |
INVOICE_PAYMENT
Shown as "Payment".
| Key | Label | Type |
|---|---|---|
total_amount | Amount | decimal (dollars) |
creator | Created by | reference to USER |
voided_datetime | Voided | datetime |
deleted_datetime | Deleted | datetime |
deleted_in_qbo | Deleted in QuickBooks | boolean |
INVOICE_RECIPIENT_EMAIL
Shown as "Recipient email".
| Key | Label | Type |
|---|---|---|
email | string |
LABEL_TEMPLATE
Shown as "Label template".
| Key | Label | Type |
|---|---|---|
name | Name | string |
context | Type | enum |
width_in_inches | Width (inches) | number |
height_in_inches | Height (inches) | number |
dpi | DPI | number |
layers | Design | list of label elements |
LICENSE
Shown as "License".
| Key | Label | Type |
|---|---|---|
license_number | License number | string |
license_type | License type | string |
active | Active | boolean |
issue_datetime | Issue date | datetime |
expiry_datetime | Expiry date | datetime |
LOCATION
Shown as "Location".
| Key | Label | Type |
|---|---|---|
name | Name | string |
street_address | Street address | string |
apt | Apt/Suite | string |
city | City | string |
state | State | string |
zip | ZIP code | string |
country | Country | string |
license | License | reference to LICENSE |
deleted_at | Deleted | datetime |
MATERIAL_TEST_RESULT
Shown as "Test result".
| Key | Label | Type |
|---|---|---|
test_result | Test result | reference to TEST_RESULT |
is_primary | Primary | boolean |
MENU
Shown as "Menu".
| Key | Label | Type |
|---|---|---|
name | Internal menu name | string |
external_name | External menu name | string |
active | Published | boolean |
visibility | Visibility | enum |
passcode_version | Passcode version | number |
discoverable | Promote on DistruCommerce | boolean |
owner | Owner | reference to USER |
default_view_mode | Default menu view | enum |
default_order_status | Default order status | enum |
auto_create_invoice_for_sales_rep_orders | Create invoices for sales rep orders | boolean |
minimum_order_subtotal | Minimum order subtotal | decimal (dollars) |
minimum_order_lead_time_days | Minimum order lead time (days) | number |
available_delivery_days | Delivery days | enum |
buyer_can_select_delivery_date | Allow buyers to select a delivery date | boolean |
collect_accounting_contact | Collect accounting contact at checkout | boolean |
sell_by_case_only | Sell by case only | boolean |
allow_customers_to_over_order | Allow customers to order more than the available quantity | boolean |
show_inventory_levels | Show available inventory levels | boolean |
show_products_with_no_inventory_mode | Show products without inventory | enum |
hide_prices_mode | Hide prices | enum |
hide_original_price_when_price_tier_applied | Hide original price if pricing tiers are applied | boolean |
allow_selling_by_potency | Sell products by total THC % | boolean |
show_coa | Show COA | boolean |
show_total_cbd | Show total CBD | boolean |
show_tac | Show TAC | boolean |
show_expiration_date | Show expiration date | boolean |
show_package_date | Show package date | boolean |
allow_buyers_to_request_trade_samples | Allow buyers to request trade samples | boolean |
restrict_trade_sample_request_to_products_in_cart | Trade samples only for products in the cart | boolean |
allow_sales_reps_to_override_net_terms | Allow sales reps to override default net terms | boolean |
allow_partner_orders | Allow orders from connected apps | boolean |
allow_ai_order_agent_email_intake | AI order intake by email | boolean |
buyer_default_order_owner_mode | Buyer orders' owner | enum |
buyer_default_order_owner | Buyer orders' owner user | reference to USER |
seller_default_order_owner_mode | Sales rep orders' owner | enum |
seller_default_order_owner | Sales rep orders' owner user | reference to USER |
send_internal_order_notifications | Send internal order notifications | boolean |
download_menu_pdf_mode | Allow buyers to download menu PDF/CSVs | enum |
accent_color | Accent color | string |
show_menu_title | Show home page title | boolean |
menu_title | Home page title | string |
company_logo | Logo | reference to IMAGE |
company_logo_transparent | Logo has transparent background | boolean |
show_company_logo | Show logo on menu and customer emails | boolean |
show_company_logo_in_marketplace | Show logo in marketplace | boolean |
favicon_image | Favicon | reference to IMAGE |
show_favicon_image | Show favicon | boolean |
show_banner_image | Show banner image | boolean |
banner_carousel_interval_seconds | Banner timing (seconds) | number |
banner_carousel_transition | Banner transition | enum |
company_description | Company description | string |
show_company_description | Show company description | boolean |
show_company_info | Show contact info | boolean |
company_info_address | Contact address | string |
company_info_email | Contact email | string |
company_info_phone | Contact phone | string |
company_info_url | Contact website | string |
show_custom_pre_checkout_message | Show cart custom message | boolean |
custom_pre_checkout_message | Cart custom message | string |
show_custom_post_checkout_message | Show order confirmation custom message | boolean |
custom_post_checkout_message | Order confirmation custom message | string |
show_brand_filter | Show brand filter | boolean |
brand_filter_custom_name | Brand filter name | string |
show_category_type_filter | Show category type filter | boolean |
category_type_filter_custom_name | Category type filter name | string |
show_category_filter | Show category filter | boolean |
show_subcategory_filter | Show subcategory filter | boolean |
show_product_group_filter | Show product group filter | boolean |
product_group_filter_custom_name | Product group filter name | string |
show_strain_filter | Show strain filter | boolean |
strain_filter_custom_name | Strain filter name | string |
show_strain_type_filter | Show strain type filter | boolean |
strain_type_filter_custom_name | Strain type filter name | string |
invite_title | Invite email title | string |
invite_content | Invite email content | string |
creator | Created by | reference to USER |
MENU_BANNER_IMAGE
Shown as "Banner image".
| Key | Label | Type |
|---|---|---|
image | Image | reference to IMAGE |
MENU_COLLECTION
Shown as "Collection".
| Key | Label | Type |
|---|---|---|
custom_name | Name | string |
hidden | Hidden | boolean |
featured | Only featured products | boolean |
thc_range_min | Total THC from | number |
thc_range_max | Total THC to | number |
thc_range_unit | Total THC unit | enum |
MENU_COLLECTION_BRAND
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
brand | Brand | reference to COMPANY |
MENU_COLLECTION_IMAGE
Shown as "Category image".
| Key | Label | Type |
|---|---|---|
image_source | Image | enum |
image | Custom image | reference to IMAGE |
MENU_COLLECTION_OFFICIAL_PRODUCT_CATEGORY
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
official_product_category | Category type | reference to OFFICIAL_PRODUCT_CATEGORY |
MENU_COLLECTION_PRODUCT_CATEGORY
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
product_category | Category | reference to PRODUCT_CATEGORY |
MENU_COLLECTION_PRODUCT_GROUP
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
product_group | Product group | reference to PRODUCT_GROUP |
MENU_COLLECTION_PRODUCT_SUBCATEGORY
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
product_subcategory | Subcategory | reference to PRODUCT_SUBCATEGORY |
MENU_COLLECTION_STRAIN
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
strain | Strain | reference to STRAIN |
MENU_COLLECTION_STRAIN_TYPE
Shown as "Collection filter".
| Key | Label | Type |
|---|---|---|
strain_type | Strain type | enum |
MENU_HOLDER
Shown as "Inventory source".
| Key | Label | Type |
|---|---|---|
location | Location | reference to LOCATION |
inventory_user | Held by | reference to USER |
MENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENT
Shown as "Order notification recipient".
| Key | Label | Type |
|---|---|---|
user | User | reference to USER |
MENU_OFFICIAL_PRODUCT_CATEGORY_TO_SELL_BY_POTENCY
Shown as "Category sold by THC".
| Key | Label | Type |
|---|---|---|
official_product_category | Category type | reference to OFFICIAL_PRODUCT_CATEGORY |
MENU_PRICE_TIER
Shown as "Menu".
| Key | Label | Type |
|---|---|---|
menu | Menu | reference to MENU |
MENU_PRODUCT
Shown as "Product".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
MENU_URL
Shown as "URL".
| Key | Label | Type |
|---|---|---|
url | URL | string |
primary | Current URL | boolean |
ORDER_ITEM
Shown as "Order line".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
quantity | Quantity | number |
price | Price | decimal (dollars) |
package | Package | reference to PACKAGE |
batch | Batch | reference to BATCH |
location | Location | reference to LOCATION |
inventory_user | Held by | reference to USER |
note | Note | string |
is_sample | Sample | boolean |
received_quantity | Received | number |
ORDER_SHIPMENT
Shown as "Shipment".
| Key | Label | Type |
|---|---|---|
shipment_number | Shipment number | string |
status | Status | string |
shipment_datetime | Shipment date | datetime |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
order | Sales order | reference to SALES_ORDER |
from_location | From location | reference to LOCATION |
shipping_location | Shipping location | reference to LOCATION |
billing_location | Billing location | reference to LOCATION |
external_notes | External notes | string |
internal_notes | Internal notes | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
include_shipping_manifest | Shipping manifest | boolean |
shipping_manifest_estimated_datetime_of_arrival | Estimated arrival | datetime |
shipping_manifest_actual_datetime_of_departure | Departure | datetime |
shipping_manifest_distributor_actual_datetime_of_arrival | Arrival | datetime |
shipping_manifest_driving_directions | Driving directions | string |
shipping_manifest_distributor_business_name | Distributor | string |
shipping_manifest_distributor_state_license_number | Distributor license number | string |
shipping_manifest_distributor_state_license_type | Distributor license type | string |
shipping_manifest_distributor_street_address | Distributor address | string |
shipping_manifest_distributor_city_state_zip | Distributor city, state, ZIP | string |
shipping_manifest_distributor_phone_number | Distributor phone | string |
shipping_manifest_distributor_contact_name | Distributor contact | string |
shipping_manifest_distributor_driver_name | Driver | string |
shipping_manifest_distributor_driver_license_number | Driver license number | string |
shipping_manifest_distributor_driver_license_issuing_state | Driver license state | string |
shipping_manifest_distributor_vehicle_make | Vehicle make | string |
shipping_manifest_distributor_vehicle_model | Vehicle model | string |
shipping_manifest_distributor_vehicle_license_plate_number | License plate | string |
shipping_manifest_distributor_vehicle_license_plate_state | License plate state | string |
shipping_manifest_shipper_business_name | Shipper | string |
shipping_manifest_shipper_state_license_number | Shipper license number | string |
shipping_manifest_shipper_state_license_type | Shipper license type | string |
shipping_manifest_shipper_street_address | Shipper address | string |
shipping_manifest_shipper_city_state_zip | Shipper city, state, ZIP | string |
shipping_manifest_shipper_phone_number | Shipper phone | string |
shipping_manifest_shipper_contact_name | Shipper contact | string |
shipping_manifest_receiver_business_name | Receiver | string |
shipping_manifest_receiver_state_license_number | Receiver license number | string |
shipping_manifest_receiver_state_license_type | Receiver license type | string |
shipping_manifest_receiver_street_address | Receiver address | string |
shipping_manifest_receiver_city_state_zip | Receiver city, state, ZIP | string |
shipping_manifest_receiver_phone_number | Receiver phone | string |
shipping_manifest_receiver_contact_name | Receiver contact | string |
ORDER_SHIPMENT_ITEM
Shown as "Shipment line".
| Key | Label | Type |
|---|---|---|
quantity | Quantity | number |
PACKAGE
Shown as "Package".
| Key | Label | Type |
|---|---|---|
compliance_label | Tag | string |
product | Product | reference to PRODUCT |
batch | Batch | reference to BATCH |
batch_number | Batch number | string |
compliance_status | Compliance status | enum |
lab_testing_state | Lab testing state | enum |
compliance_product_name | Compliance item name | string |
location | Location | reference to LOCATION |
license | License | reference to LICENSE |
unit_type | Unit | reference to UNIT_TYPE |
description | Description | string |
harvest_date | Harvest date | date |
manufactured_date | Manufactured date | date |
expiration_datetime | Expiration date | datetime |
is_production_batch | Production batch | boolean |
metrc_production_batch_number | Production batch number | string |
is_test_sample | Test sample | boolean |
is_trade_sample | Trade sample | boolean |
compliance_is_finished_good | Finished good | boolean |
finished_datetime | Finished | datetime |
inactivated_datetime | Inactivated | datetime |
creator | Created by | reference to USER |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
PACKAGE_BIN
Shown as "Bin".
| Key | Label | Type |
|---|---|---|
bin | Bin | reference to BIN |
PAYMENT
Shown as "Payment".
| Key | Label | Type |
|---|---|---|
amount | Amount | decimal (dollars) |
payment_number | Payment number | string |
payment_datetime | Payment date | datetime |
payment_method | Payment method | reference to PAYMENT_METHOD |
description | Description | string |
fully_paid_with_credits | Paid with credits | boolean |
deleted_datetime | Deleted | datetime |
PAYMENT_METHOD
Shown as "Payment method".
| Key | Label | Type |
|---|---|---|
name | Name | string |
type | Type | string |
active | Active | boolean |
deleted_at | Deleted | datetime |
PAYMENT_TERM
Shown as "Payment term".
| Key | Label | Type |
|---|---|---|
name | Name | string |
days | Days | number |
time_of_day | Time of day | string |
locked | Locked | boolean |
PLANT
Shown as "Plant".
| Key | Label | Type |
|---|---|---|
metrc_label | Tag | string |
status | Status | enum |
is_mother_plant | Mother plant | boolean |
plant_group | Plant batch | reference to PLANT_GROUP |
metrc_strain_name | Strain | string |
location | Location | reference to LOCATION |
license | License | reference to LICENSE |
harvest_group | Harvest group | reference to HARVEST_GROUP |
source_type | Source | enum |
planted_datetime | Planted | datetime |
flowered_datetime | Flowered | datetime |
destroyed_datetime | Destroyed | datetime |
removed_datetime | Removed | datetime |
PLANT_ADDITIVE
Shown as "Plant additive".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
batch | Batch | reference to BATCH |
quantity | Quantity | number |
unit_type | Unit | reference to UNIT_TYPE |
location | Location | reference to LOCATION |
application_device | Application device | string |
application_date | Application date | date |
PLANT_ADDITIVE_TARGET
Shown as "Applied to".
| Key | Label | Type |
|---|---|---|
plant | Plant | reference to PLANT |
plant_group | Plant batch | reference to PLANT_GROUP |
allocated_quantity | Quantity | number |
PLANT_ADDITIVE_TYPE
Shown as "Plant additive type".
| Key | Label | Type |
|---|---|---|
name | Name | string |
metrc_additive_type_name | Metrc type | enum |
PLANT_GROUP
Shown as "Plant batch".
| Key | Label | Type |
|---|---|---|
name | Name | string |
metrc_strain_name | Strain | string |
location | Location | reference to LOCATION |
license | License | reference to LICENSE |
planted_datetime | Planted | datetime |
metrc_source_plant_batch_names | Source plant batch | string |
metrc_source_package_label | Source package | string |
metrc_source_plant_label | Source plant | string |
PLANT_WASTE
Shown as "Plant waste".
| Key | Label | Type |
|---|---|---|
quantity | Quantity | number |
unit_type | Unit | reference to UNIT_TYPE |
waste_date | Date | date |
location | Location | reference to LOCATION |
metrc_waste_reason_name | Reason | string |
metrc_waste_method_name | Method | string |
metrc_mixed_material | Mixed material | string |
note | Note | string |
creator | Created by | reference to USER |
PLANT_WASTE_PLANT
Shown as "Wasted from".
| Key | Label | Type |
|---|---|---|
plant | Plant | reference to PLANT |
plant_group | Plant batch | reference to PLANT_GROUP |
PRICE_TIER
Shown as "Pricing tier".
| Key | Label | Type |
|---|---|---|
name | Name | string |
external_name | External name | string |
price_or_percent | Discount by | enum |
is_flat | Flat price | boolean |
price | Amount | decimal (dollars) |
percent | Percent | decimal (percent) |
conditions | Conditions | one field per condition, named as GET /public/v1/price-tiers names it (<key>.one_of_products): a list of the IDs you may see that still exist, null when none; min_quantity {quantity, unit_type_id}; total_thc_percentage_range {min, max} (quantity and bounds as decimal strings) |
valid_from_datetime | Valid from | datetime |
valid_until_datetime | Valid until | datetime |
menu_mode | Menus | enum |
menu_promo_enabled | Menu promo | boolean |
menu_promo_card_type | Promo card type | enum |
menu_promo_card_background_hex | Promo card background color | string |
menu_promo_card_text_hex | Promo card text color | string |
menu_promo_card_emoji | Promo card emoji | string |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
deleted_datetime | Deleted | datetime |
PRODUCT
Shown as "Product".
| Key | Label | Type |
|---|---|---|
name | Name | string |
external_name | External name | string |
sku | SKU | string |
upc | UPC | string |
description | Description | string |
category | Category | reference to PRODUCT_CATEGORY |
subcategory | Subcategory | reference to PRODUCT_SUBCATEGORY |
product_group | Group | reference to PRODUCT_GROUP |
brand | Brand | reference to COMPANY |
vendor | Vendor | reference to COMPANY |
strain | Strain | reference to STRAIN |
inventory_tracking_method | Inventory tracking | enum |
unit_type | Unit | reference to UNIT_TYPE |
unit_price | Price | decimal (dollars) |
wholesale_unit_price | Wholesale price | decimal (dollars) |
msrp | MSRP | decimal (dollars) |
unit_cost | Unit cost | decimal (dollars) |
units_per_case | Units per case | number |
unit_net_weight | Net quantity per unit | number |
unit_serving_size | Net quantity per serving | number |
unit_net_weight_serving_size_unit_type | Net quantity unit | reference to UNIT_TYPE |
gross_weight | Gross weight | number |
gross_weight_unit_type | Gross weight unit | reference to UNIT_TYPE |
flower_equivalent_quantity_in_grams | Flower equivalent (grams) | number |
total_thc | Total THC | number |
total_cbd | Total CBD | number |
total_cannabinoid_unit | Cannabinoid unit | enum |
michigan_tax_category | Michigan tax category | string |
quantity_available_threshold_min | Low stock alert | number |
quantity_available_threshold_max | High stock alert | number |
menu_visibility | Menus | enum |
is_featured | Featured | boolean |
max_menu_buyer_order_quantity | Max menu order quantity | number |
dcomm_partial_unit_increment | Partial unit increment | enum |
quickbooks_sales_item | QuickBooks sales item | reference to QUICKBOOKS_ITEM |
quickbooks_purchase_item | QuickBooks purchase item | reference to QUICKBOOKS_ITEM |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
is_active | Active | boolean |
deleted_at | Deleted | datetime |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
PRODUCT_CATEGORY
Shown as "Product category".
| Key | Label | Type |
|---|---|---|
name | Name | string |
official_product_category | Category type | reference to OFFICIAL_PRODUCT_CATEGORY |
biotrack_inventory_type_id | BioTrack inventory type | integer |
blaze_omit_from_sync | Blaze: ignored | boolean |
dutchie_omit_from_sync | Dutchie: ignored | boolean |
treez_omit_from_sync | Treez: ignored | boolean |
deleted_datetime | Deleted | datetime |
PRODUCT_GROUP
Shown as "Product group".
| Key | Label | Type |
|---|---|---|
name | Name | string |
PRODUCT_SUBCATEGORY
Shown as "Subcategory".
| Key | Label | Type |
|---|---|---|
name | Name | string |
PRODUCT_TAG
Shown as "Tag".
| Key | Label | Type |
|---|---|---|
tag | Tag | reference to TAG |
PROFILE
Shown as "Profile".
| Key | Label | Type |
|---|---|---|
title | Title | string |
first_name | First name | string |
last_name | Last name | string |
email | string | |
phone_number | Phone | string |
work_phone_number | Work phone | string |
description | Description | string |
PURCHASE
Shown as "Purchase".
| Key | Label | Type |
|---|---|---|
purchase_number | Purchase number | string |
status | Status | string |
payment_status | Payment status | string |
company | Supplier | reference to COMPANY |
order_datetime | Order date | datetime |
due_datetime | Due date | datetime |
total | Total | decimal (dollars) |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
location | Warehouse | reference to LOCATION |
supplier_location | Pickup location | reference to LOCATION |
billing_location | Billing location | reference to LOCATION |
order | Created from sales order | reference to SALES_ORDER |
compliance_transfer | Compliance transfer | reference to COMPLIANCE_TRANSFER |
description | Notes | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
deleted_in_qbo | Deleted in QuickBooks | boolean |
include_shipping_manifest | Shipping manifest | boolean |
shipping_manifest_estimated_datetime_of_arrival | Manifest estimated arrival | datetime |
shipping_manifest_actual_datetime_of_departure | Manifest actual departure | datetime |
shipping_manifest_distributor_actual_datetime_of_arrival | Manifest actual arrival | datetime |
shipping_manifest_driving_directions | Manifest driving directions | string |
shipping_manifest_distributor_state_license_number | Manifest distributor license number | string |
shipping_manifest_distributor_state_license_type | Manifest distributor license type | string |
shipping_manifest_distributor_business_name | Manifest distributor business name | string |
shipping_manifest_distributor_street_address | Manifest distributor street address | string |
shipping_manifest_distributor_city_state_zip | Manifest distributor city, state, ZIP | string |
shipping_manifest_distributor_phone_number | Manifest distributor phone | string |
shipping_manifest_distributor_contact_name | Manifest distributor contact | string |
shipping_manifest_distributor_driver_name | Manifest driver name | string |
shipping_manifest_distributor_driver_license_number | Manifest driver license number | string |
shipping_manifest_distributor_driver_license_issuing_state | Manifest driver license state | string |
shipping_manifest_distributor_vehicle_make | Manifest vehicle make | string |
shipping_manifest_distributor_vehicle_model | Manifest vehicle model | string |
shipping_manifest_distributor_vehicle_license_plate_number | Manifest vehicle license plate | string |
shipping_manifest_distributor_vehicle_license_plate_state | Manifest vehicle plate state | string |
shipping_manifest_receiver_state_license_number | Manifest receiver license number | string |
shipping_manifest_receiver_state_license_type | Manifest receiver license type | string |
shipping_manifest_receiver_business_name | Manifest receiver business name | string |
shipping_manifest_receiver_street_address | Manifest receiver street address | string |
shipping_manifest_receiver_city_state_zip | Manifest receiver city, state, ZIP | string |
shipping_manifest_receiver_phone_number | Manifest receiver phone | string |
shipping_manifest_receiver_contact_name | Manifest receiver contact | string |
shipping_manifest_shipper_state_license_number | Manifest shipper license number | string |
shipping_manifest_shipper_state_license_type | Manifest shipper license type | string |
shipping_manifest_shipper_business_name | Manifest shipper business name | string |
shipping_manifest_shipper_street_address | Manifest shipper street address | string |
shipping_manifest_shipper_city_state_zip | Manifest shipper city, state, ZIP | string |
shipping_manifest_shipper_phone_number | Manifest shipper phone | string |
shipping_manifest_shipper_contact_name | Manifest shipper contact | string |
PURCHASE_PAYMENT
Shown as "Payment".
| Key | Label | Type |
|---|---|---|
creator | Created by | reference to USER |
voided_datetime | Voided | datetime |
deleted_in_qbo | Deleted in QuickBooks | boolean |
RECURRING_SCHEDULE
Shown as "Schedule".
| Key | Label | Type |
|---|---|---|
recurring_type | Repeats | enum |
separation_count | Every | number |
hour_of_day | Hour | number |
day_of_week | Day of the week | enum |
week_of_month | Week of the month | enum |
day_of_month | Day of the month | enum |
RELATIONSHIP_TYPE
Shown as "Relationship type".
| Key | Label | Type |
|---|---|---|
name | Name | string |
RETURN
Shown as "Return".
| Key | Label | Type |
|---|---|---|
return_number | Return number | string |
status | Status | string |
return_datetime | Return date | datetime |
total | Total | decimal (dollars) |
company | Customer | reference to COMPANY |
order | Sales order | reference to SALES_ORDER |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
location | Return source (location) | reference to LOCATION |
inventory_user | Return source (user) | reference to USER |
should_create_credit | Create a credit when completed | boolean |
description | Notes | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
RETURN_ITEM
Shown as "Return line".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
quantity | Quantity | number |
price | Price | decimal (dollars) |
batch | Batch | reference to BATCH |
location | Return to (location) | reference to LOCATION |
inventory_user | Return to (user) | reference to USER |
waste | Waste | boolean |
description | Description | string |
ROLE
Shown as "Role".
| Key | Label | Type |
|---|---|---|
name | Name | string |
admin | Admin | boolean |
permissions | Permissions | one boolean field per permission: <key>.<permission> |
SALES_ORDER
Shown as "Sales order".
| Key | Label | Type |
|---|---|---|
order_number | Order number | string |
status | Status | string |
order_datetime | Order date | datetime |
due_datetime | Due date | datetime |
delivery_datetime | Delivery date | datetime |
total | Total | decimal (dollars) |
company | Customer | reference to COMPANY |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
billing_location | Billing location | reference to LOCATION |
shipping_location | Shipping location | reference to LOCATION |
location | Inventory source | reference to LOCATION |
inventory_user | Inventory source user | reference to USER |
payment_term_name | Payment terms | string |
external_notes | External notes | string |
internal_notes | Internal notes | string |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
request | Request | reference to REQUEST |
compliance_transfer | Compliance transfer | reference to COMPLIANCE_TRANSFER |
combined_order | Merged into | reference to SALES_ORDER |
blaze_payment_type | Blaze payment type | enum |
menu | Menu | reference to MENU |
buyer_company | Buyer | reference to ACCOUNT |
buyer_creator | Placed by | reference to USER, another company's: {id: null, name} |
buyer_shipping_location | Buyer shipping location | reference to LOCATION, another company's: {id: null, name} |
buyer_billing_location | Buyer billing location | reference to LOCATION, another company's: {id: null, name} |
buyer_note | Buyer note | string |
buyer_phone_number | Buyer phone | string |
accounting_contact_name | Accounting contact name | string |
accounting_contact_email | Accounting contact email | string |
accounting_contact_phone | Accounting contact phone | string |
partner | Partner | reference to PARTNER |
metrc_transfer_template_recipient_license_number | Metrc template recipient license | string |
metrc_transfer_template_type | Metrc template transfer type | string |
metrc_transfer_template_directions | Metrc template directions | string |
metrc_transfer_template_invoice_number | Metrc template invoice number | string |
metrc_transfer_template_payment_term_days | Metrc template payment term days | number |
SCHEDULED_ALERT
Shown as "Scheduled alert".
| Key | Label | Type |
|---|---|---|
type | Type | enum |
recipient_users | Recipients | list of references to USER |
days_until_expiration | Days before expiration | number |
stock_statuses | Inventory statuses | enum |
email_customer_statement | Email customers their statement | boolean |
SIGNATURE
Shown as "Signature".
| Key | Label | Type |
|---|---|---|
signer_name | Signer name | string |
signer_email | Signer email | string |
signer_phone | Signer phone | string |
description | Description | string |
STOCK_ADJUSTMENT
Shown as "Stock adjustment".
| Key | Label | Type |
|---|---|---|
reason | Reason | enum |
quantity | Quantity | number |
product | Product | reference to PRODUCT |
batch | Batch | reference to BATCH |
package | Package | reference to PACKAGE |
location | Location | reference to LOCATION |
owner | Held by | reference to USER |
completion_datetime | Date | datetime |
reference_number | Reference number | string |
description | Description | string |
creator | Created by | reference to USER |
STOCK_TRANSFER
Shown as "Transfer".
| Key | Label | Type |
|---|---|---|
stock_transfer_number | Transfer number | string |
status | Status | string |
transfer_type | Type | enum |
description | Description | string |
initiated_datetime | Initiated | datetime |
completed_datetime | Completed | datetime |
source_location | Source warehouse | reference to LOCATION |
target_location | Target warehouse | reference to LOCATION |
source_user | Source user | reference to USER |
target_user | Target user | reference to USER |
source_license | Source license | reference to LICENSE |
target_license | Target license | reference to LICENSE |
owner | Owner | reference to USER |
creator | Created by | reference to USER |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
include_shipping_manifest | Shipping manifest | boolean |
shipping_manifest_estimated_datetime_of_arrival | Manifest estimated arrival | datetime |
shipping_manifest_actual_datetime_of_departure | Manifest actual departure | datetime |
shipping_manifest_distributor_actual_datetime_of_arrival | Manifest actual arrival | datetime |
shipping_manifest_driving_directions | Manifest driving directions | string |
shipping_manifest_distributor_state_license_number | Manifest distributor license number | string |
shipping_manifest_distributor_state_license_type | Manifest distributor license type | string |
shipping_manifest_distributor_business_name | Manifest distributor business name | string |
shipping_manifest_distributor_street_address | Manifest distributor street address | string |
shipping_manifest_distributor_city_state_zip | Manifest distributor city, state, ZIP | string |
shipping_manifest_distributor_phone_number | Manifest distributor phone | string |
shipping_manifest_distributor_contact_name | Manifest distributor contact | string |
shipping_manifest_distributor_driver_name | Manifest driver name | string |
shipping_manifest_distributor_driver_license_number | Manifest driver license number | string |
shipping_manifest_distributor_driver_license_issuing_state | Manifest driver license state | string |
shipping_manifest_distributor_vehicle_make | Manifest vehicle make | string |
shipping_manifest_distributor_vehicle_model | Manifest vehicle model | string |
shipping_manifest_distributor_vehicle_license_plate_number | Manifest vehicle license plate | string |
shipping_manifest_distributor_vehicle_license_plate_state | Manifest vehicle plate state | string |
shipping_manifest_receiver_state_license_number | Manifest receiver license number | string |
shipping_manifest_receiver_state_license_type | Manifest receiver license type | string |
shipping_manifest_receiver_business_name | Manifest receiver business name | string |
shipping_manifest_receiver_street_address | Manifest receiver street address | string |
shipping_manifest_receiver_city_state_zip | Manifest receiver city, state, ZIP | string |
shipping_manifest_receiver_phone_number | Manifest receiver phone | string |
shipping_manifest_receiver_contact_name | Manifest receiver contact | string |
shipping_manifest_shipper_state_license_number | Manifest shipper license number | string |
shipping_manifest_shipper_state_license_type | Manifest shipper license type | string |
shipping_manifest_shipper_business_name | Manifest shipper business name | string |
shipping_manifest_shipper_street_address | Manifest shipper street address | string |
shipping_manifest_shipper_city_state_zip | Manifest shipper city, state, ZIP | string |
shipping_manifest_shipper_phone_number | Manifest shipper phone | string |
shipping_manifest_shipper_contact_name | Manifest shipper contact | string |
STOCK_TRANSFER_ITEM
Shown as "Transfer line".
| Key | Label | Type |
|---|---|---|
product | Product | reference to PRODUCT |
quantity | Quantity | number |
package | Package | reference to PACKAGE |
batch | Batch | reference to BATCH |
STRAIN
Shown as "Strain".
| Key | Label | Type |
|---|---|---|
name | Name | string |
strain_type | Type | enum |
TAG
Shown as "Tag".
| Key | Label | Type |
|---|---|---|
name | Name | string |
TASK
Shown as "Task".
| Key | Label | Type |
|---|---|---|
name | Name | string |
status | Status | string |
due_datetime | Due | datetime |
owner | Owner | reference to USER |
description | Description | string |
location | Location | reference to LOCATION |
creator | Created by | reference to USER |
custom_data | Custom data | one field per custom field ID: <key>.<custom field ID> |
TAX
Shown as "Tax".
| Key | Label | Type |
|---|---|---|
name | Name | string |
tax_code | Tax code | string |
tax_rate_percent | Tax rate | decimal (percent) |
description | Description | string |
tax_applied_after_charges | Applied after charges and discounts | boolean |
tax_applied_after_price_tiers | Applied after pricing tier discounts | boolean |
is_michigan_tax | Michigan state tax | boolean |
michigan_tax_type | Michigan tax type | enum |
company_categories | Company categories | string (comma-separated values) |
creator | Created by | reference to USER |
deleted_datetime | Deleted | datetime |
TAX_TAG
Shown as "Tag".
| Key | Label | Type |
|---|---|---|
tag | Tag | reference to TAG |
TEAM
Shown as "Team".
| Key | Label | Type |
|---|---|---|
name | Name | string |
agent_definition_restriction_level | Custom agents visibility | enum |
ai_skill_restriction_level | AI skills visibility | enum |
assembly_restriction_level | Assemblies visibility | enum |
batch_restriction_level | Batches visibility | enum |
company_relationship_restriction_level | Companies visibility | enum |
contact_restriction_level | Contacts visibility | enum |
credit_restriction_level | Credits visibility | enum |
invoice_restriction_level | Invoices visibility | enum |
menu_restriction_level | Menus visibility | enum |
order_restriction_level | Sales orders visibility | enum |
order_shipment_restriction_level | Shipments visibility | enum |
price_tier_restriction_level | Pricing tiers visibility | enum |
product_restriction_level | Products visibility | enum |
purchase_restriction_level | Purchases visibility | enum |
request_restriction_level | Requests visibility | enum |
return_restriction_level | Returns visibility | enum |
stock_transfer_restriction_level | Transfers visibility | enum |
task_restriction_level | Tasks visibility | enum |
deleted_datetime | Deleted | datetime |
TEAM_MEMBERSHIP
Shown as "Member".
| Key | Label | Type |
|---|---|---|
user | Member | reference to USER |
is_manager | Manager | boolean |
TEARDOWN
Shown as "Teardown".
| Key | Label | Type |
|---|---|---|
name | Name | string |
status | Status | enum |
grown_for | Grown for | reference to COMPANY |
is_manicure | Manicure | boolean |
creator | Created by | reference to USER |
removed_datetime | Removed | datetime |
TEARDOWN_INPUT
Shown as "Plant".
| Key | Label | Type |
|---|---|---|
plant | Plant | reference to PLANT |
quantity | Weight | number |
unit_type | Unit | reference to UNIT_TYPE |
location | Location | reference to LOCATION |
removed_datetime | Removed | datetime |
TEARDOWN_MAPPING
Shown as "Plant to harvest".
| Key | Label | Type |
|---|---|---|
removed_datetime | Removed | datetime |
TEARDOWN_OUTPUT
Shown as "Harvest".
| Key | Label | Type |
|---|---|---|
harvest | Harvest | reference to HARVEST |
quantity | Weight | number |
location | Location | reference to LOCATION |
license | License | reference to LICENSE |
status | Status | enum |
pending_datetime | Submitted for review | datetime |
completed_datetime | Completed | datetime |
removed_datetime | Removed | datetime |
TEST_RESULT
Shown as "Test result".
| Key | Label | Type |
|---|---|---|
name | Name | string |
lab_name | Lab | string |
lab_license_number | Lab license | string |
release_date | Release date | date |
package | Package | reference to PACKAGE |
batch | Batch | reference to BATCH |
thc_percentage | THC | decimal (percent) |
total_thc_percentage | Total THC | decimal (percent) |
thc_mg_per_unit | THC per unit | number |
total_thc_mg_per_unit | Total THC per unit | number |
cbd_percentage | CBD | decimal (percent) |
total_cbd_percentage | Total CBD | decimal (percent) |
cbd_mg_per_unit | CBD per unit | number |
total_cbd_mg_per_unit | Total CBD per unit | number |
mg_per_unit_type | Per unit in | string |
additional_user_test_results | Additional user test results | one field per test: <key>.<test> |
additional_metrc_test_results | Additional metrc test results | one field per test: <key>.<test> |
uploader | Uploaded by | reference to USER |
UNIT_TYPE
Shown as "Unit type".
| Key | Label | Type |
|---|---|---|
name | Name | string |
category | Category | enum |
active | Enabled | boolean |
pos_count_based | Sync to POS as count-based | boolean |
leaflink_unit_name | LeafLink unit | string |
USER
Shown as "User".
| Key | Label | Type |
|---|---|---|
email | string | |
role | Role | reference to ROLE |
deactivated_datetime | Deactivated | datetime |
deleted_at | Deleted | datetime |
VEHICLE
Shown as "Vehicle".
| Key | Label | Type |
|---|---|---|
make | Make | string |
model | Model | string |
year | Year | string |
color | Color | string |
license_plate_number | License plate | string |
license_plate_state | License plate state | string |
vin | VIN | string |
description | Description | string |
biotrack_vendor_license_number | Vendor license | string |
biotrack_qa_lab_license_number | Lab license | string |
creator | Created by | reference to USER |
deleted_datetime | Deleted | datetime |