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": "2d5cc224-3e2f-498a-a2dc-a02571b7a114",
"_parent_id": "f18ee625-ce99-4114-adea-b63218ccb90b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9acb7041-2b2f-46d4-868d-4d45319d5db5",
"company_id": "18a30966-8dea-4c81-a948-3302d79880d4",
"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": "6456e75b-b0f3-48f1-aabc-e8a39c5a0be0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "50a035bb-6d7f-4ed3-b813-9ce30ed6969d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4382c1ae-d7c4-4e5f-8513-a1a2bc46d1aa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4c0a94bd-b0b2-479a-b320-877142e47994",
"company_code": "sample string 5",
"company": {
"id": "9921b58e-3af9-4bd8-af71-90bdc3df062a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-03T22:40:41.8255573+00:00",
"sales_territory_id": "f9ead50c-d181-400f-b8ef-ec11317c6b07",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "137ff78e-c6f1-4b22-b59a-44179d7f0bcf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d59b6fb-a193-44f5-bcca-59c18b9aeafe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b05fe12e-d526-412c-aa36-cbcdacac7711",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eaa2c63-69ad-4dce-a1a3-2117210ce88f",
"db_currency_id": "6eb2a6fc-40d9-4837-a68d-5562bf01915c",
"db_language_id": "d6b5d347-e808-419a-b559-2a5200ec4b4b",
"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-10-03T22:40:41.8255573+00:00"
},
"modified_dateutc": "2026-10-03T22:40:41.8255573+00:00"
},
"marketing_segment_id": "9741100e-9b62-4852-aff2-b2eee64f2a9c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "efebb616-883a-4e96-8d39-7d9993bd169a",
"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": "727f8ee0-8f1c-4b1f-8908-d52b08b8e5c5",
"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": "e79ae078-76e4-40da-bf6f-6bf2517154aa",
"db_country_code": "sample string 28",
"feelist_id": "aa01550f-b06e-4cb7-b19d-43592390ace5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2c28f593-e537-4be1-936e-8c307c0da2db",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b367b186-32ab-4783-9ede-a4fec6c9c858",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-03T22:40:41.8255573+00:00",
"db_currency_id": "715fc79e-39ec-4eb2-812d-23fb91ac70e3",
"db_currency_code": "sample string 10"
},
"company_type_id": "0fe99a0d-e906-406e-8952-85415d602658",
"company_type_name": "sample string 32",
"company_type": {
"id": "1bd691e5-830b-4f56-8483-6df4bd4b0b4d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44658d6f-8bdb-4a5a-8998-5359b4b63078",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3cb7574f-6160-4f32-8ae0-fe74774fa3b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f59b104-045d-4024-b372-173aac67340b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6061a6c1-a8a2-4bdc-a539-7e04311c1759",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ef1801b-922d-463d-8e90-ecfa81a82aa6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-03T22:40:41.8255573+00:00"
},
"company_sector_id": "cbf59715-c8a4-4051-8561-dadf3b88ba18",
"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": "f2fd618f-5a58-4128-9675-7025f1fe4b52",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bdba9239-7de8-49f7-bbc7-537099c7d480",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "96d05119-47c9-436a-bd3b-a619a67c5f02",
"account_manager_user_code": "sample string 56",
"company_status_id": "138c7165-7bc6-4caf-a33e-68389e4f1cab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-03T22:40:41.842415+00:00",
"id2": 60
},
"db_language_id": "994ce3cf-0d9d-45a4-8c50-eb5d6aa440e5",
"db_language_code": "sample string 7",
"db_title_id": "00da013e-1af7-47ce-a1f8-41eb0939fd96",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-03T22:40:41.842415+00:00",
"create_date": "2026-10-03T22:40:41.842415+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-10-03T22:40:41.842415+00:00"
},
"modified_dateutc": "2026-10-03T22:40:41.842415+00:00",
"id2": 22
}