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": "7a7e7dd2-afde-4735-b6b7-2e93c70268b5",
"_parent_id": "81ef8a2d-62b8-4b83-9065-8192640c947e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1fea920a-7d21-4e82-9ee9-f90a1b5d2c0b",
"company_id": "77faa071-a6a1-4e45-bd51-31095aa52449",
"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": "89a6ac84-0521-46b5-a008-352f9dc3f094",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "42f7848a-5f35-4ad7-a634-cab550c89bd7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c54c9df2-0bc0-4b80-93a2-727bfb921723",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e359a1f8-8e1f-467a-a1a8-977d5a979ee8",
"company_code": "sample string 5",
"company": {
"id": "7b3645f4-774e-44f3-b3cf-40e403c6227f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T18:45:26.297633+00:00",
"sales_territory_id": "9491161c-a00a-402e-89a8-e2b589bd67cd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0f79defc-b893-4dc8-bb47-d293f433636d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2532db03-c9b6-402d-b992-f00c8f378a9a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9284c92-5cd1-4253-a244-0457c0ea16ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c30203-6a9b-429e-9e91-f307de85446b",
"db_currency_id": "0cbf5abd-9834-466e-9dbc-b2136e8fdbd4",
"db_language_id": "3beb49d7-e1c7-411f-88ab-3bb740695524",
"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-12-05T18:45:26.297633+00:00"
},
"modified_dateutc": "2025-12-05T18:45:26.297633+00:00"
},
"marketing_segment_id": "a81ba53b-45b7-42dd-93d2-9849c959f386",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a0ecca36-8cc0-4f67-b6a2-0ad80d5a5491",
"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": "3458d42b-8a4a-420f-b365-c7edad074411",
"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": "acd38005-6013-468a-836b-4c3747553839",
"db_country_code": "sample string 28",
"feelist_id": "cfca22c4-67cd-49d5-97bc-808b5f5b132a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "748341af-2538-4f55-88fd-e2c718ed126c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c6c8a28c-035c-4749-b038-616ef5a3c6fc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T18:45:26.297633+00:00",
"db_currency_id": "9625c56b-4d7a-4d56-b635-2e763b950dc8",
"db_currency_code": "sample string 10"
},
"company_type_id": "fc042d96-555b-4e4c-93e2-78373c2b4f1e",
"company_type_name": "sample string 32",
"company_type": {
"id": "be281d3e-217c-4414-93da-129e7d80e823",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5829e7d-f8d6-46f5-b2a8-43187c455118",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b16cd5fc-477b-4f35-b6d6-a8d08c48a16b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e8e2f02b-1cd4-4197-859a-85774cea2221",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f0c3acd7-030f-41bc-b819-984f85b82bd6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b083e57f-b7da-4a31-8332-a41bc249a7b2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T18:45:26.297633+00:00"
},
"company_sector_id": "aeaa3028-66fa-4d65-8d27-ab361fd2a92d",
"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": "619d255e-a15b-4b6b-b884-b8e4c040420e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f3d1137d-ea16-493f-805d-ae9ebfa60469",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "375678aa-0e56-44d5-bbf1-1a557ec32d6b",
"account_manager_user_code": "sample string 56",
"company_status_id": "36498112-03d9-4335-b986-0fca95be70ec",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T18:45:26.297633+00:00",
"id2": 60
},
"db_language_id": "39003208-ce3f-4411-9ed1-0cf4e9738a59",
"db_language_code": "sample string 7",
"db_title_id": "dd564e40-c70a-4353-a32a-08b98b5dc3b6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T18:45:26.297633+00:00",
"create_date": "2025-12-05T18:45:26.297633+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-12-05T18:45:26.297633+00:00"
},
"modified_dateutc": "2025-12-05T18:45:26.297633+00:00",
"id2": 22
}