Retrieves an object of the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Response Formats
application/json, text/json
Sample:
{
"id": "8ef3f396-179d-41ec-9750-b9412a4e98f8",
"_parent_id": "b77ee136-1c64-40a1-a567-b4940bee5f1e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "91158cfd-2929-4521-b171-665fd2e9d7ca",
"company_id": "5d8d731b-9ac5-4c5b-bd44-f550c7b111f2",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "9cb42d46-8044-48a4-836e-4461d48e201b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3ed8a5a2-99c6-4330-8a1d-b8a03734121c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "290b33a2-0576-4c1c-a4c4-045f23bb4f4d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7019aad0-27ce-41f3-bc2b-4ffd5453239a",
"company_code": "sample string 5",
"company": {
"id": "4cd48e77-0ee0-4552-96f4-e78f115ac1ad",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-24T11:01:50.7666038+00:00",
"sales_territory_id": "16315a4e-50eb-40ce-96c5-fa8948a4e249",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "33295b40-205f-4b9f-920d-7e7ed4b774fc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "234be710-fdaf-48b5-94c1-9e1b8e50a814",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e4e81924-21e0-4491-b367-d1ef98aed381",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aa2f3c2-3df9-4cd1-abe2-9d9b6544178c",
"db_currency_id": "69200e5a-55eb-4085-b206-91630f5aacd2",
"db_language_id": "9925a7e8-54fb-4281-85b9-f7dd90261301",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00"
},
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00"
},
"marketing_segment_id": "fc7fde61-5a6e-4ef8-be27-a49b2966d28a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ce7cfe21-9c89-430c-83cd-47d7049d979c",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "394aee2c-6e31-48fb-a213-36b999514e90",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "a9513ee1-b91e-41a2-9ad0-215ad25fef9b",
"db_country_code": "sample string 28",
"feelist_id": "0595a139-32d9-43d6-ad4d-7b27a747578b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e3381043-d24f-4441-8da0-2e3b85323a1f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "821b594a-6928-4646-8cce-12af3d643cfb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00",
"db_currency_id": "0c07e309-8b5c-4e50-9204-23dadbf2f404",
"db_currency_code": "sample string 10"
},
"company_type_id": "40e71056-20f9-4eea-828e-56dad16b100c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ed4ebc11-8496-4dbb-9cb5-ef68e3f1a140",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "178ad9d5-e71a-4dc7-bb7a-1c76479a0ed9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dcf55884-4f68-439e-9604-05aafb8a5fd9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf82333a-bf87-4bf0-a004-ac76af52bd54",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9679e647-9181-4965-a5ec-d3d0e0dc0fda",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a622f4bb-2046-4c1e-b9ca-67530823471a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00"
},
"company_sector_id": "cf83d419-b418-4dc1-bed4-eeef99a160fc",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "7d173589-ff6e-4437-a236-7952908d2992",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "955700e9-d239-40c0-a62c-8d183e42397f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5ab0c49-63cb-47b9-8b61-7a2b7e259dd0",
"account_manager_user_code": "sample string 56",
"company_status_id": "3bc42195-db41-455d-a59d-c3503870a768",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00",
"id2": 60
},
"db_language_id": "46d3a859-cc53-439f-86af-1d10d78b868a",
"db_language_code": "sample string 7",
"db_title_id": "eb00dbe6-80f9-41c2-a043-f480bd429ef3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-24T11:01:50.7666038+00:00",
"create_date": "2026-04-24T11:01:50.7666038+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00"
},
"modified_dateutc": "2026-04-24T11:01:50.7666038+00:00",
"id2": 22
}