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": "ea711baa-13c1-4c74-9ea0-22cb1a9d8e3f",
"_parent_id": "778253c7-3ceb-4eea-a78d-6c31cabd4dfc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1232fe15-a327-4677-8445-e7688dd7a7c4",
"company_id": "275a897f-2e36-4efe-bfe4-66790c31be2b",
"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": "d7d47e2a-08d9-4b38-ada9-6cf5efa326f5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a915d5d6-f919-4432-91e4-fa24a6c48499",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a36f32ae-8a2e-4f4e-a436-66bb13593a1e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5b9e53dc-7af8-444f-b6d4-313a1605dbe8",
"company_code": "sample string 5",
"company": {
"id": "7b767fa2-d199-40bb-b7fd-59cce2686543",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-01T08:56:52.6006586+00:00",
"sales_territory_id": "81c7cf14-be80-42c4-8c4b-359a2429e626",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "77abad94-f385-4b3d-9f43-e6c5e6abe36e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a2c3a3a8-8f5d-4a3f-9746-4ecde86c488a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b46f8062-80c9-48a3-8c56-a9ef193a0ff6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "531f3ec4-32e3-4e12-bfe6-fb2b38d38c94",
"db_currency_id": "617569a9-276e-4e34-a394-18ee0ce0a1ca",
"db_language_id": "1ed624ec-f40e-4d8c-934c-026d6da94d56",
"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-01T08:56:52.6006586+00:00"
},
"modified_dateutc": "2026-10-01T08:56:52.6006586+00:00"
},
"marketing_segment_id": "4df8b98f-d6fb-41b3-9d6a-f1f1babfadf1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1bf2694f-e996-464b-ba8a-1ffcbf3dcfc8",
"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": "4f985593-8f13-42be-8ae7-d5b3c59feab4",
"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": "6daa5925-1ccb-4edf-9193-54e18afd6c8a",
"db_country_code": "sample string 28",
"feelist_id": "31dff6db-6e6b-4131-8268-8a062eec3b9c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4c5d0d2f-bf5b-43f2-8b4e-80a8f6c737d8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5aaf139-3767-4edc-b282-44e31388a6b4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-01T08:56:52.6006586+00:00",
"db_currency_id": "f0515bb1-dbcd-4140-a2f0-8be496a33bb5",
"db_currency_code": "sample string 10"
},
"company_type_id": "3667b0cd-fbc0-4034-a098-5ad39e2c2901",
"company_type_name": "sample string 32",
"company_type": {
"id": "16050eae-dc42-4f58-81c5-4fa64e911fc4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c210f060-7905-48a7-a9b0-408e7309efe0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d4832fa5-22ed-4456-8d35-dbd64506c3e0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1f5e985c-e333-4bc4-ad78-06ab477b5a7e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b318ec39-d3f1-46df-9769-57535767d591",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2f017cf-6403-487f-bf4b-d153f620f6d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-01T08:56:52.6006586+00:00"
},
"company_sector_id": "12e17fa8-c6f0-4508-b9e5-f3518d30151c",
"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": "5efe0514-3054-4c6a-9ee4-cde18b45b46d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2b95358-e4ac-41b1-8f0e-14f9e50ff0a8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f9fb93d4-a84c-472e-84ff-cfe25bc5091f",
"account_manager_user_code": "sample string 56",
"company_status_id": "6898e0ad-54d5-4ca8-bd46-be42dedea688",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-01T08:56:52.6006586+00:00",
"id2": 60
},
"db_language_id": "39495181-ef8d-4325-9da9-cf15b2f7fe5f",
"db_language_code": "sample string 7",
"db_title_id": "940834ae-016f-4942-89c8-fdaa9c4ab497",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-01T08:56:52.6006586+00:00",
"create_date": "2026-10-01T08:56:52.6006586+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-01T08:56:52.6006586+00:00"
},
"modified_dateutc": "2026-10-01T08:56:52.6006586+00:00",
"id2": 22
}