Name
A name is a customer, supplier, patient, manufacturer or donor, or maybe a combination of these.
| Field name | Description | mSupply Use | Reference link | Type | Indexed |
|---|---|---|---|---|---|
| ID | The unique ID given to this name | Not used in UI | Alpha | * | |
| Related to asset.name_id, backorder.name_id_customer, backorder.name_id_supplier, contact.name_ID, Goods_received_line.manufacturer_ID, HIS_encoutner.PATIENT_ID, item_line.name_ID, item_line.manufacturer_ID, item_store_join.non_stock_name_ID, list_group.name_id, list_name_join.name_ID, name_budget.name_ID, name_note.name_ID, name_stock_history.name_ID, name_store_join.name_ID, patient_medication.name_ID, purchase_order.name_ID, purchase_order_line.non_stock_name_ID, quote.names_ID, quote_line.manufacturer_ID, quote_line.name_ID, regimen_record.name_ID, repeat_table.name_ID, store.name_ID, transact.name_ID, web_favourite.name_ID, tender.benchmarkSupplier_ID,[goods_received]donor_id,[item_line]donor_id, [purchase_order]donor_id, [trans_line]donor_id | |||||
| name | Name's name | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Name | https://docs.msupply.org.nz/names:adding_and_editing#adding_a_new_customer | Text | * |
| fax | Name's phone number | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Fax | Alpha | ||
| phone | Name's phone number | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Phone | Alpha | ||
| customer | True if this name is a customer | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Customer | Boolean | * | |
| bill_address1 | Billing address line 1 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Main/Billing Address 1 | Alpha | ||
| bill_address2 | Billing address line 2 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Main/Billing Address 2 | Alpha | ||
| supplier | True if this name is a supplier | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Supplier | https://docs.msupply.org.nz/names:adding_and_editing#adding_a_new_supplier | Boolean | * |
| charge code | Code to charge a name's transactions to when exporting | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Charge to | https://docs.msupply.org.nz/names:adding_and_editing#charge_to | Alpha | * |
| margin | The margin applied to the cost price of this supplier's goods to calculate the sell price | New/Edit Name(supplier)»General Tab»Margin(Only shown if the name is supplier in Supplier details) | https://docs.msupply.org.nz/names:adding_and_editing#extra_information_for_suppliers_only | Real | |
| comment | Comment stored against this name | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Comment | Text | ||
| currency_ID | Supplier only: ID of the currency this supplier uses | Alpha | |||
| country | Billing address country | New/Edit Name(supplier/customer/manufacture/doner)»General tab»Country(Main/Billing) | Alpha | ||
| freightfac | Multiplier to apply to quote lines to account for freight charges | New/Edit Name(supplier)»General Tab»Freight factor(Only shown if the name is supplier in Supplier details) | https://docs.msupply.org.nz/names:adding_and_editing#extra_information_for_suppliers_only | Real | |
| Name's email address. You can put multiple email addresses here separated by commas. | New/Edit Name(supplier/customer/manufacture/doner)»General tab»email(contact) | Alpha | |||
| custom1 | Custom field 1 contents - defined by user | New/Edit Name(supplier/customer/manufacture/doner)»General tab»Custom 1 | Alpha | ||
| code | This name's code | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Code | https://docs.msupply.org.nz/names:adding_and_editing#name_code | Alpha | * |
| last | Patients only: patient's last name | New/Edit Name(Patient)»General tab»Last | Alpha | * | |
| first | Patients only: patient's first name | New/Edit Name(Patient)»General tab»First | Text | * | |
| title | Patients only: patient's title (Mr, Ms etc.) | Text | |||
| female | Patients only: True if female, False if male | New/Edit Name(Patient)»General tab»Female | Boolean | ||
| date_of_birth | Patients only: patient's date of birth | New/Edit Name(Patient)»General tab»Date of Birth | Date | ||
| overpayment | Deprecated as of v4.11 and not used - calculated as needed Amount overpaid to a customer from a supplier | Real | |||
| group_ID | ID of the department this name has been assigned to | Alpha | * | ||
| hold | If true, you can't issue or receive items to/from this name | New/Edit Name(supplier/customer/manufacture/doner/patient)»General Tab»Hold (Status) | https://docs.msupply.org.nz/names:adding_and_editing#status_-_hold_checkbox | Boolean | |
| ship_address1 | Shipping address line 1 | New/Edit Name(supplier/customer/manufacture/doner)»General tab»Shipping Address 1 | Alpha | ||
| ship_address2 | Shipping address line 2 | New/Edit Name(supplier/customer/manufacture/doner)»General tab»Shipping Address 2 | Alpha | ||
| url | Web page of this name. Includes “http://” | New/Edit Name(supplier/customer/manufacture/doner)»General tab»web site | Alpha | ||
| barcode | Set to the code field with an '*' at either end. Doesn't seem to be used for anything… | Text | |||
| postal_address1 | Postal address line 1 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | |
| postal_address2 | Postal address line 2 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | |
| category1_ID | ID of the category1 level3 category this name has been assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 1 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| religion_ID | Patients only: ID of the patient's religion | Alpha | |||
| type | “store” - a name associated with an mSupply virtual store “invad” - a reserved name used for inventory adjustment transactions “build” - a reserved name used for build transactions “repack” - a reserved name used for repack transactions “patient” - patients “facility” - a supplier or customer who is external to your mSupply virtual store system (see booleans name.customer and name.supplier for differentiation) | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Type | https://docs.msupply.org.nz/names:adding_and_editing#type | Text | * |
| price_category | The price category (A-F) this name is assigned to | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Price category | https://docs.msupply.org.nz/names:adding_and_editing#price_category | Alpha | |
| flag | Comma separated list of flags assigned to this name | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Flag | Alpha | ||
| manufacturer | True if this name is a manufacturer | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Manufacturer | Boolean | ||
| print_invoice_alphabetical | If true, invoice lines are printed in alphabetical order for this name | Boolean | |||
| custom2 | Custom field 2 contents - defined by user | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Custom 2 | Alpha | ||
| custom3 | Custom field 3 contents - defined by user | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Custom 3 | Alpha | ||
| default_order_days | The default number of days that this customer orders for in a customer stock history | Integer | |||
| connection_type | The type of connection to the internet the name has: 1=low bandwidth, 2=high bandwidth | Integer | |||
| PATIENT_PHOTO | Patients only: patient's photo | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Photo | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Picture | |
| NEXT_OF_KIN_ID | Patients only: ID of the patient's next of kin (another patient) | Alpha | * | ||
| POBOX | Patients only: the patient's PO Box, part of their address | Alpha | |||
| ZIP | Postal address postcode | Long Integer | |||
| middle | Patients only: patient's middle name | Text | |||
| preferred | If true this supplier is a preferred supplier when comparing bids in a tender | Boolean | |||
| Blood_Group | Patients only: patient's blood group | Alpha | |||
| marital_status | Patients only: patient's marital status | Alpha | |||
| Benchmark | True if name is a benchmark supplier, against which others' prices are to be compared | Boolean | |||
| next_of_kin_relative | Relation that is patient's next of kin e.g. 'Parent' | Alpha | |||
| mother_id | Patients only: ID of the patient's mother (another patient) | Alpha | * | ||
| postal_address3 | Postal address line 3 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Postal Address 3 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | |
| postal_address4 | Postal address line 4 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Postal Address 4 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | |
| bill_address3 | Billing address line 3 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Address 3(Main/Billing) | Alpha | ||
| bill_address4 | Billing address line 4 | New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Address 4(Main/Billing) | Alpha | ||
| ship_address3 | Shipping address line 3 | New/Edit Name(customer)»General Tab»Address 3(Shipping address) | Alpha | ||
| ship_address4 | Shipping address line 4 | New/Edit Name(customer)»General Tab»Address 4(Shipping address) | Alpha | ||
| ethnicity_ID | Patients only: ID of the patient's ethnicity | Alpha | * | ||
| occupation_ID | Patients only: ID of the patient's occupation | Alpha | * | ||
| religion_ID | Patients only: ID of the patient's religion | Alpha | * | ||
| national_health_number | Patients only: patient's national health number | Alpha | |||
| Master_RTM_Supplier_Code | The code this supplier has in the RTM | Long Integer | * | ||
| ordering_method | The type of customer stock history this customer uses: im=imprest, sh=stock history | Alpha | |||
| donor | True if the name is a donor | New/Edit Name(supplier/customer/manufacture/doner)»General tab»Doner (Category) | https://docs.msupply.org.nz/names:adding_and_editing#donor_checkbox | Boolean | * |
| latitude | The degrees latitude of the name's location | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Real | ||
| longitude | The degrees longitude of the name's location | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Real | ||
| Master_RTM_Supplier_name | The name of this supplier in the RTM | Alpha | |||
| category2_ID | ID of the category2 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 2 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| category3_ID | ID of the category3 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 3 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| category4_ID | ID of the category4 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 4 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| category5_ID | ID of the category5 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 5 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| category6_ID | ID of the category6 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)»General Tab»Category 6 | https://docs.msupply.org.nz/names:name_categories | Alpha | * |
| bill_address5 | Billing address line 5 | New/Edit Name(supplier/manufacture)»Main/Billing Address 5 | Alpha | ||
| bill_postal_zip_code | Billing address postcode | Alpha | |||
| postal_address5 | Postal address line 5 | New/Edit Name(supplier/manufacture)»General tab»Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#tags_tab | Alpha | |
| postal_zip_code | Postal address postcode | Alpha | |||
| ship_address5 | Shipping address line 5 | New/Edit Name(supplier/manufacture)»General tab»Shipping Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#tags_tab | Alpha | |
| ship_postal_zip_code | Shipping address postcode | New/Edit Name(supplier/manufacture)»General tab»Shipping Address 5 | Alpha | ||
| supplying_store_id | Store that supplies customer | New/Edit Name(Customer)»General tab»Supplying Store(Customer details) | https://docs.msupply.org.nz/names:adding_and_editing#supplying_store | Alpha | |
| license_number | Alpha | ||||
| license_expiry | Date | ||||
| has_current_license | Boolean | ||||
| custom_data | Object | ||||
| maximum_credit | This is the maximum debt that a patient's account can have when the payments module is activated | New patient»General tab»Credit limit | https://docs.msupply.org.nz/dispensing:patients#general_tab | Real | |
| nationality_ID | Alpha | ||||
| created_date | Date | ||||
| integration_reference_ID | Alpha | ||||
| isDeceased | Boolean | ||||
| is_deleted | Is true if the name is soft delete | Not shown in UI | Boolean | ||
| om_created_datetime | Alpha | ||||
| om_gender | Alpha | ||||
| HSH_name | HSH name used for Health Supply Hub to link suppliers or manufacturers with their record on the Health Supply Hub server and maintained by The mSupply Foundation | New/Edit Name(supplier/customer/manufacture/doner)»General tab»HSH name | https://docs.msupply.org.nz/names:adding_and_editing#hsh_code_hsh_name | Alpha | |
| HSH_code | HSH code used for Health Supply Hub to link suppliers or manufacturers with their record on the Health Supply Hub server and maintained by The mSupply Foundation | New/Edit Name(supplier/customer/manufacture/doner)»General tab»HSH code | https://docs.msupply.org.nz/names:adding_and_editing#hsh_code_hsh_name | Alpha | |
| HSH_ID | ID of the HSH code | Not use in UI | Alpha | ||
| om_date_of_death | Date | ||||
| spare_alpha_1 | Alpha | ||||
| spare_alpha_2 | Alpha | ||||