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": "a8105ec4-5ec0-4891-a5e9-e3e40afe80b4",
"_parent_id": "cf7b426b-045c-49cd-94d8-b87002f9815b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "90687013-d020-4c70-abd5-daebc2cbc15a",
"company_id": "5539ccfd-56be-4650-88db-267558350fd4",
"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": "b95b226f-23e4-47ad-a93c-b51fc02356f5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2f79993f-4efd-4ce5-ac78-ba129caaf47c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "53064f4e-f686-41c0-a700-5a5a4d7b7581",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6b4ba5ca-eb0a-4e86-ae38-f1451bcc885a",
"company_code": "sample string 5",
"company": {
"id": "fde6baad-a45f-4eec-86d3-7c1523fb27d4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-04T12:08:38.7539902+00:00",
"sales_territory_id": "ba287058-90ec-44bf-9e09-3c2d8840fc75",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e41942a6-2632-48f5-bea5-666e6d3169a2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f33ffb6-6412-4f39-aea7-0e8ecaedfa12",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a58124b-4f2b-4bf8-982b-63e63c754225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c55f67e0-4fd8-45bb-9d3b-badba496efa6",
"db_currency_id": "7025da46-ab51-411d-9ec1-ee7d69e4ac3d",
"db_language_id": "9eae6083-77c6-40e5-9315-40b90123941a",
"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": "2025-06-04T12:08:38.7539902+00:00"
},
"modified_dateutc": "2025-06-04T12:08:38.7539902+00:00"
},
"marketing_segment_id": "d1fd24b4-e8ba-438c-8fdf-3b545548f94a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6694a0a8-8d53-42f5-ba6a-fb53a7abedb9",
"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": "dcdd3a5f-c7d7-4fd7-9f8a-935e9475149a",
"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": "bac7bdf5-2418-4947-bc26-2dc3599e4146",
"db_country_code": "sample string 28",
"feelist_id": "6816b2a4-7d3b-4a9a-91e1-0c94f4e9a68e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ef4fe1e3-8c00-4b31-9bee-d5c8be3d3ee3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a0edf808-e1fb-488b-90dd-2fe71a2eaf4d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-04T12:08:38.7539902+00:00",
"db_currency_id": "f2525339-82ad-48e3-9ea3-e19332332fbd",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1843145-ed1d-4c9b-b139-bb9f3b9d6369",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3d75b66-e9d9-437c-92d6-e0142aea2fac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0b3eff4-3f1b-4173-972a-b39fdb2a1b19",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1cd43868-4016-418e-bed0-013b376b6aeb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f4509aaf-1d40-43fb-b93f-012905b42c1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "48f1e3a7-d936-4166-99de-34298ebf51f9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "211fac29-cf3b-43d6-9bf6-968f9af93c11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-04T12:08:38.7539902+00:00"
},
"company_sector_id": "cba39219-16eb-4be5-9367-c1f8422e475c",
"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": "ec165211-558b-42d9-a73f-9e466535d205",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "aa780a7c-4370-452a-8778-3de87931423d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "998b7868-d606-4fa6-8bbe-d0c86b9ec42f",
"account_manager_user_code": "sample string 56",
"company_status_id": "877cdbe1-dc1f-4f66-a44e-9867c1618ed2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-04T12:08:38.7539902+00:00",
"id2": 60
},
"db_language_id": "e576f750-39b8-4787-9aaf-23464c8d93a6",
"db_language_code": "sample string 7",
"db_title_id": "a1d11aeb-f858-4b83-b85d-f7f8816f03a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-04T12:08:38.7539902+00:00",
"create_date": "2025-06-04T12:08:38.7539902+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": "2025-06-04T12:08:38.7539902+00:00"
},
"modified_dateutc": "2025-06-04T12:08:38.7539902+00:00",
"id2": 22
}