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": "9154dfe4-0be5-4e9a-98dd-0613b9289db3",
"_parent_id": "b582a037-c4bb-418f-b4f2-3716bf7fa7d6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "622a0345-57d0-480d-ad72-94de87e26246",
"company_id": "80a5b056-00d5-42a2-9a19-5fcbdae34717",
"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": "583a41e9-4270-4849-862b-0af7dbc5b9b2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "968b5977-6f71-4a17-aa5c-af9d6e07ab8b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2ec59341-52f3-4505-b89c-97d8b697046a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "11c1aa0b-376b-4b18-a63f-dddc6810d342",
"company_code": "sample string 5",
"company": {
"id": "71e625d0-d910-48c9-b808-8ef79956b325",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T03:22:11.8456224+00:00",
"sales_territory_id": "1df36978-7153-48a2-b3a3-ea436f3ca6ff",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a211fdfc-5c5c-41b3-ab81-d04246709166",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6944eab9-7173-4450-b86e-bb34df20fd2b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e96d32d-d9c2-4dff-b685-525aeda6a614",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c02a990-9856-453b-ac81-237dc1b9bf12",
"db_currency_id": "abd95561-f3de-468c-bf5c-e37a715bd0a4",
"db_language_id": "c7184c5d-fe4e-4e4a-b089-af501e24afb7",
"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-09-16T03:22:11.8456224+00:00"
},
"modified_dateutc": "2026-09-16T03:22:11.8456224+00:00"
},
"marketing_segment_id": "26838d4e-a80a-4ab8-8659-6bcba57f0521",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "422fe39f-56c5-499d-8222-2eed8646dd89",
"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": "77de72ad-e04f-4a70-9445-84fb1803ffa0",
"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": "0224d84d-3ca7-40dd-8b2b-6c2a0fcde098",
"db_country_code": "sample string 28",
"feelist_id": "f3096134-5b8d-49d7-a34d-7141743f254b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5614229d-5d52-4338-bff7-5e3cf098859f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "26e641c9-d14d-419d-afd8-dcf54b9ea4af",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T03:22:11.8456224+00:00",
"db_currency_id": "ced5ac92-2723-47d6-b98f-54cddc57fcd7",
"db_currency_code": "sample string 10"
},
"company_type_id": "1a49c8eb-84f1-4218-9f3f-fe5736691897",
"company_type_name": "sample string 32",
"company_type": {
"id": "995a349e-1728-43b8-b588-494598e81a54",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4956bf03-ffa9-4fa6-9f42-c68881a04457",
"sales_organization_code": "sample string 5"
},
"db_language_id": "efa8e7ae-64e5-4643-9a71-78e3a5624f01",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "032a352d-51b4-47ac-9251-c712705fd8b1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b7868d1f-a671-41ef-a961-fab55ac2a294",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3317ac1d-23e7-49d3-9a55-8a37ab1ea8ab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T03:22:11.8456224+00:00"
},
"company_sector_id": "52f3f333-c3d4-43ed-bd72-a09ab955af93",
"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": "ecdfdf18-3d1b-4b26-85c7-55718a2ad82d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "baa99bd0-2ed6-42ea-bebd-cdbe17f253b4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f41bfa16-1b73-49e4-924b-8d08e0e8b414",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3924906-2494-4c59-a750-b76755fb3662",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T03:22:11.8456224+00:00",
"id2": 60
},
"db_language_id": "7edc8f24-484a-4b1a-8886-fcbe6e0eff05",
"db_language_code": "sample string 7",
"db_title_id": "67d33cc0-6816-4573-9207-3548004f797d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T03:22:11.8456224+00:00",
"create_date": "2026-09-16T03:22:11.8456224+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-09-16T03:22:11.8456224+00:00"
},
"modified_dateutc": "2026-09-16T03:22:11.8456224+00:00",
"id2": 22
}