Parameters Explained
Distributor Endpoint - Body Parameters
| Data Point | Description | Example/Options |
|---|---|---|
| id | An unique ID that is assigned to a distributor upon creation. This value will not change. When updating a distributor you'll need to include the ID in the body of the request. | 12846edd-a097-491a-a61e-f369e589dc0c |
| type | This field lists the type of relationship the distributor has with the client. This field impacts tax calculations for inventory | Accepted Values: NON_ARMS_LENGTH ARMS_LENGTH |
| company | The name of the distributor company. | JIMMY'S DISTRIBUTION |
| doing_business_as | Optional field for entering distributor DBA | J's DISTRO |
| address | Address that is associated with the distributor profile. | 999 Broadway STREET, CA |
| phone | Phone that is associated with the distributor profile. | 5109876543 |
| Email associated with distributor. | [email protected] | |
| default_payment_term | default payment term | PIA Net 30 |
| lead_time | The lead time to receiving a delivery from a distributor. | 10 |
| delivery_days | This field lists the preferred day of delivery for a distributor. | Accepted Values: MON TUE WED THU FRI SAT SUN |
| preferred_payment_method | Preferred payment method for the distributor | ACH CASH |
| active | Current status of the distributor. | true false |
| available_credit | The credit that is available for the store for with the distributor. | 100.00000 |
| outstanding_balance | The amount owed to the vendor | 5000 |
| licenses | Array containing license information for a distributor. | - |
| id | Unique ID associated with the license of the distributor. | 84162573-9938-4170-b116-65ef71224774 |
| label | Type of license | DISTRIBUTOR |
| type | This field indicates the type of inventory the license can sell. | ALL |
| license_number | License number for distributors license. | Cl-23413254123 |
| expiration_date | Expiration date associated to the distributor license. | 2024-09-28T00:00:00.000-07:00 |
| status | The current status of the | active inactive |
Location Endpoint - Body Parameters
| Data Point | Description | Example/Options |
|---|---|---|
| id | Unique ID associated to an inventory location. | 03b2249e-e70a-4ab9-80b8-25bb8c804a81 |
| active | Current status of the location and if it is available for use. | true false |
| inventory_type | This field lists the inventory types that can be stored at a particular location. | ALL MEDICAL ADULT |
| name | Name assigned to a particular location. | DOWNTOWN-VEHICLE-1 |
| parent_location_id | List of parent locations for | dee203b0-6ff7-11e9-b685-0280fd4571a6 |
| sellable | This field indicates whether inventory can be sold from this location. | true false |
Payment Term Endpoint - Body Parameters
| Data Point | Description | Examples/Options |
|---|---|---|
| id | A unique ID assigned to the payment term. This value will not change once assigned to a term. | 636bc474-49b4-11e9-8035-774805423a5c |
| label | Short name of payment terms. | COD PIA EOM |
| payment_due | Long name of payment terms. | Cash on Delivery Pay in Advance End of Month |
Invoice Endpoint - Body Parameters
| Data Point | Description | Examples/Options |
|---|---|---|
| id | ID associated to the invoice upon creation. This value will not change once assigned to an invoice. When updating a invoice you'll need to include the ID in the body of the request. | 7edd5430-2ae0-4cb8-91a5-c594bb297a25 |
| visible_id | Client facing invoice number. | 703 |
| total_cost | Read only This field shows the calculated total cost of the entire invoice. | 1080.63 |
| distributor_id | ID associated to the distributor | 4fd8c626-b568-4c94-93b5-207470c74978 |
| inventory_location | The inventory locations that were assigned to the invoice was originally added to Treez. This field is case sensitive | BACK OF HOUSE |
| inventory_type | Medical: inventory that can only be sold as Medical Recreational: inventory that can only be sold as Recreational Custom: Non-cannabis inventory like Merch that can be sold to Medical and Recreational customers | MEDICAL RECREATIONAL CUSTOM |
| external_invoice_id | Invoice number from the original vendor invoice. Can be used optionally in addition to the Treez auto-generated invoice number. | TF1721827 |
| status | The current status of the invoice. | DRAFT ACCEPTED |
| note | Notes associated with an invoice. | Example note for an invoice |
| payment_terms | Payment Term Label. Valid payment terms are set to the Delivery Payment Terms Config Page. Use Payment Terms API to retrieve list. | COD |
| created_date | The inventory locations that have been setup with the Treez instance. Case sensitive | 2022-10-06T17:59:49.000-07:00 |
| last_updated_date | Date and time the invoice was last updated. | 2022-10-06T18:18:16.000-07:00 |
| accepted_date | Time and Date of when an invoice was accepted | 2022-10-06T18:18:16.000-07:00 |
| due_date | Date the invoice is due to the vendor. | 2022-10-21T00:00:00.000-07:00 |
| discounts | Invoice level discount array. | - |
| id | Unique ID associated with the invoice level discount. | 4236675d-064c-4254-9b3c-48650aeabb89 |
| label | Name of the invoice level discount. | Loyal Shop Discount |
| discount_type | Type of invoice level discount. | DOLLAR PERCENTAGE |
| discount_amount | Number value of the discount. | 10 |
| invoice_line_list | Array containing the invoice line details | - |
| id | ID for the invoice line level. This ID will not change once assigned to a line item. | 53a3bcc6-7d95-4cee-9b50-d8a17cdb2513 |
| product_id | ID of the product that is assigned to the invoice line. You can use the product API to get the details of the product. | 83ee87ce-dff1-46a8-af39-1ee62dc50e91 |
| quantity | total weight or units being received for an invoice line item. | 100.000000 |
| base_cost_unit | Cost per unit excluding excise tax including fees and discounts. | 10.000000 |
| excise_tax_unit | Excise tax per unit (CALIFORNIA ONLY). | 1.706250 |
| true_cost_unit | Read only This field shows the calculated cost per unit excluding excise including discounts | 9.100000 |
| total_cost | Read only This field shows the calculated Total Cost for the invoice line (includes excise) | 1080.625000 |
| outstanding_balance | Read only Shows the amount of the total_cost that is still owed to the distributor | 1987.45 |
| payment_status | Read only Shows the overall payment status of the invoice | Possible values:DRAFTPARTIALLY PAIDPAID |
| payments | A data object that shows details on any payments that have been made against the invoice balance. If there are no payments or the payment_status is DRAFT, the corresponding fields in the payments array will display NULL. | |
| payment_date | The date and time of the payment | 2023-05-19T10:00:01.000-07:00 |
| payment_user | The user name of the Treez user who applied the payment | CURTIS |
| payment_amount | The amount of the payment | 127.36 |
| transaction_type | The type of transaction | Possible values:Cash HandlingCredit Note |
| payment_source | The source for the payment (e.g., Account Name if transaction_type is Cash Handling, or N/A if transaction_type is Credit Note) | CD01 |
| payment_notes | Any notes entered for the payment | Paid per agreed terms |
| manifest_number | Incoming Manifest Number | 00000001x |
| dispensary_license | License of dispensary receiving the invoice. | C23423-LIC |
| harvest_date | Harvest date of the invoice line item. | 2022-06-23 |
| received_date | Received date of the invoice line item. | 2022-10-06 |
| expiration_date | Expiration date of the invoice line item. | 2022-10-22 |
| external_batch_id | Batch tracking or state compliance tracking ID such as Metrc Package number. | 180234714793847 |
| barcode | List of scannable barcodes for an invoice line item | bgr |
| discount | Invoice line level discount array. | - |
| id | Unique ID associated with the invoice line level discount. | c0f616f2-9ff0-4623-a473-c85a0cf2f8a8 |
| label | Name of the invoice line level discount. | Invoice Line 5% Discount |
| discount_type | Type of invoice line level discount. | DISCOUNT PERCENTAGE |
| discount_amount | Number value of the fee. | -5 |
| fees | Invoice line level fee array. | - |
| id | Unique ID associated with the invoice line level fee. | 5a8ae23f-1a2e-4a47-a605-67c01f26c26a |
| label | Name of the invoice line level fee. | Invoice Line 25 Fee |
| fee_type | Type of invoice line level fee. | DISCOUNT PERCENTAGE |
| fee_amount | Number value of the fee. | 25 |
| custom_invoice_fields | custom fields object | - |
| name | The name of the custom field record | erp_record_id |
| description | The description of the custom field record | ID of the invoice in the ERP system |
| value | The value of the custom field | 87071G |
| open_label_field_1 | Open field for label maker for an invoice line item | null |
| open_label_field_2 | Open field for label maker for an invoice line item | PREROLL |
| open_label_field_3 | Open field for label maker for an invoice line item | null |
Updated 5 months ago