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": "497a78d3-a1dd-4600-bf41-a9bc9242d276",
"_parent_id": "0a689fb2-e6c5-46d5-9fef-fb7f7ef8cd44",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "04f59bf4-3ba4-405a-96f6-92285c0475ff",
"company_id": "66845a92-b354-4e33-a9e6-4d0742e0ba70",
"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": "2d07ce83-c5b2-4721-8393-22355e772322",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "63578746-ab47-49e2-af80-e3dab2ff57ec",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "28f6cf39-7a4f-4d37-ace3-c566b275666d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05deae0b-5a57-4e38-8a22-f76da6efe336",
"company_code": "sample string 5",
"company": {
"id": "9a94a27e-ad21-4878-84d9-9bedb9d03f17",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-08T03:00:43.6887354+00:00",
"sales_territory_id": "cf179154-b98d-45fb-94ed-55f16c2ae74c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4ae97b7-974a-47b0-a4c8-75458390c8d2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "70854524-cddd-4e2c-a65e-69e860262c2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "68b169a5-9b5a-4777-a2ad-9c4303b4195b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e262c87-0745-40c5-8ee9-b30473c67288",
"db_currency_id": "501c4d22-3035-4ef9-80f7-8d2cba28c637",
"db_language_id": "a280bd36-a823-40df-9039-3bc24b43edc6",
"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-03-08T03:00:43.6887354+00:00"
},
"modified_dateutc": "2026-03-08T03:00:43.6887354+00:00"
},
"marketing_segment_id": "9ca3058d-f24c-48b8-9d5a-c7d4cc69714b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "733d0a61-aa07-41a7-beaa-67936c6f3fa7",
"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": "8c89db0e-acbe-4a0e-a11c-03fe839565cb",
"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": "7dc6866c-cf98-404d-9fe5-cb7fee6fea73",
"db_country_code": "sample string 28",
"feelist_id": "be139fac-a5be-496d-80a2-123e2eb9ada1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a349b095-afb9-4283-ada1-42f2f2c0a92e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "30fd3a86-7207-4bd8-abf0-f3d86e6f3408",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-08T03:00:43.6887354+00:00",
"db_currency_id": "4e3d2602-0d7a-47ea-b070-73593430a70c",
"db_currency_code": "sample string 10"
},
"company_type_id": "0c390397-de3c-46a4-a25b-32c11626a285",
"company_type_name": "sample string 32",
"company_type": {
"id": "94ab1886-3cdc-43e4-acf5-742481def018",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1e2f2fb0-9d89-425f-86e0-387d03e03fc5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bfb601c3-538a-4640-aeb3-949cd5747d01",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd088aeb-81d4-4fa1-86ea-7e6c75bb948c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3eabd109-92e2-4a11-b373-b16c9a6db3b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "daf3f9ac-b0ea-48a4-91be-4a5c955980e6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-08T03:00:43.6887354+00:00"
},
"company_sector_id": "44efcb35-7142-4275-8a54-0f3870017455",
"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": "70c97b1e-212d-4e01-a9a7-9313cf849dcf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8be40b2d-87fe-4aae-8c1c-f804d2bcce83",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "33c844cd-4310-4ec0-acad-0c454a188ab3",
"account_manager_user_code": "sample string 56",
"company_status_id": "ef46507b-d04a-4623-91cb-333199e8032a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-08T03:00:43.6887354+00:00",
"id2": 60
},
"db_language_id": "ff706183-0261-4a75-98f4-18fc5675f714",
"db_language_code": "sample string 7",
"db_title_id": "cddd7506-11a4-453b-8595-e6d82ebe98d1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-08T03:00:43.6887354+00:00",
"create_date": "2026-03-08T03:00:43.6887354+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-03-08T03:00:43.6887354+00:00"
},
"modified_dateutc": "2026-03-08T03:00:43.6887354+00:00",
"id2": 22
}