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": "bb2f1488-47fb-4ef6-90c7-e3dd64c8837d",
"_parent_id": "dea92692-8151-4986-91fe-799678089bdf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a4edaf76-2454-4d11-813c-a0b15e8ff404",
"company_id": "b2f26ce2-bb44-48f1-8d91-796088e92987",
"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": "6ae00685-a458-4bcd-9bf2-66fd34b8a88a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4e5dbb77-ec33-4762-a93f-da03dbd6abad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4df41951-e8d7-4b2c-a2e5-25261fe427df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5b4531b3-ea78-4442-91ec-4f5670662e1b",
"company_code": "sample string 5",
"company": {
"id": "748735be-4cb1-4bd8-b81a-f9439186e799",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T06:12:26.9684415+00:00",
"sales_territory_id": "3decc78d-2c35-407c-be4e-9b3c72e74d7b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b2382720-3761-42c6-a906-5cadb89d4937",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c3231c4-cf63-4f9d-aeb2-ff7076368e6d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c0c0d63-48af-449f-847d-172e761b3c1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db5b188b-a38b-4a7e-9869-acd0acac6e15",
"db_currency_id": "e658f291-7bd3-470d-a0ed-9e7fdb6680df",
"db_language_id": "49ed9853-ba6f-4124-b09a-1d2bbc85e7e1",
"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-12T06:12:26.9684415+00:00"
},
"modified_dateutc": "2026-03-12T06:12:26.9684415+00:00"
},
"marketing_segment_id": "dc3ae79d-de1b-43dc-9d90-ff7c2fa5240c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2d1f8e81-4329-4fd4-b8ba-0954989280ad",
"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": "2930de96-b2c0-4b0d-82eb-0c3637b2dfa3",
"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": "01e539b9-0643-417f-8ac9-20db614d6ef5",
"db_country_code": "sample string 28",
"feelist_id": "5c00b5aa-237c-40f2-846e-1dcab6b95586",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "831080ef-3403-4ca5-87fd-ef9720e757fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "af108512-0428-4eed-ac53-c22226a31432",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T06:12:26.9684415+00:00",
"db_currency_id": "9b6699a0-dbf6-4d83-abb4-4e9c84662010",
"db_currency_code": "sample string 10"
},
"company_type_id": "6f01519a-96a9-4ec2-a764-04a23b6ce475",
"company_type_name": "sample string 32",
"company_type": {
"id": "a3a699ea-db56-45cc-872a-dae3f7b6abef",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be55a0cb-d698-4b3c-ad5a-8e961e691788",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b217fb8c-b93c-4a71-ab7b-43199512947b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "83a457c2-25bf-462d-ac14-1b636a8d14f7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "20e707c8-2460-40a7-9029-279a103734a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dbaa9eac-3c8f-48d8-8353-a3bb62761bd0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T06:12:26.9684415+00:00"
},
"company_sector_id": "88f7f653-e25e-41dc-92b4-fa0d88637be5",
"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": "2029d37f-2d9e-4b26-95a7-88e6628f4687",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "35c6619c-8242-4d92-bfd4-9d62d1af4e9a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d162b954-7e96-40cb-b226-f70c8c3cf304",
"account_manager_user_code": "sample string 56",
"company_status_id": "b41e56a5-a24a-43da-922f-5a3ae309e188",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T06:12:26.9684415+00:00",
"id2": 60
},
"db_language_id": "22084e75-7853-4de9-9c1c-d6941d02f456",
"db_language_code": "sample string 7",
"db_title_id": "cc524a27-2d59-4c86-aa2b-47ac726da46d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T06:12:26.9684415+00:00",
"create_date": "2026-03-12T06:12:26.9684415+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-12T06:12:26.9684415+00:00"
},
"modified_dateutc": "2026-03-12T06:12:26.9684415+00:00",
"id2": 22
}