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": "8f411aad-f2d5-49f7-bdfb-e5fd9a0baefd",
"_parent_id": "fc491918-dbac-41e6-8fea-3bf283a9746c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6a016f02-6853-4372-b045-0381c93689f0",
"company_id": "07a90b38-9a8d-49b5-9d73-14e9b0ea5081",
"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": "c55ad08e-bbc6-411b-be65-260f9193764a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7bed9cc3-7ed3-47e0-a82c-4945d61dd1a1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c73f8174-215b-471a-b25a-850c4cdfba48",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "13876b13-c757-47ab-80d0-5386538eb12b",
"company_code": "sample string 5",
"company": {
"id": "e8c1c960-9dad-496b-9f25-9fd310f53064",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-28T01:13:49.2280738+00:00",
"sales_territory_id": "41b80ca1-0414-48a0-9bc7-38fc27361a3c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b357f993-b93f-4073-87fc-5e85aab833a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b946f698-1497-46c7-a79a-5bf568d2fe1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "19763419-7ab3-4107-bc7d-5a8d99ce44cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f74daab-3d25-4310-8b2f-233e335f2aa6",
"db_currency_id": "3f5b25ec-49a0-4452-a62f-a45a90e2ab8e",
"db_language_id": "85f42ad3-5fa0-4df6-b9fa-f7ae48b10709",
"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-01-28T01:13:49.2280738+00:00"
},
"modified_dateutc": "2026-01-28T01:13:49.2280738+00:00"
},
"marketing_segment_id": "e23656b6-308a-4b5a-99d8-73a1b2506231",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "181681d2-11cd-41d6-9713-fd80e94531a9",
"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": "91830b39-bdde-4142-9719-a03e17f1b26a",
"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": "9f306ab9-586e-45de-989f-a752544619db",
"db_country_code": "sample string 28",
"feelist_id": "b109e73e-af58-4c78-8b95-46de47c0d4a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08549fd5-0e5b-4307-a321-1ae39d8782ca",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0691627c-c9bf-4fa1-95a2-7b027f398017",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-28T01:13:49.2280738+00:00",
"db_currency_id": "570b3d9c-7c99-4447-be4c-b6c8a93bab46",
"db_currency_code": "sample string 10"
},
"company_type_id": "d2cb74d3-a055-4f82-97bb-1ab3b470cedf",
"company_type_name": "sample string 32",
"company_type": {
"id": "244b6172-a2ef-492b-8ec3-eac540474cd1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0218b740-4465-4c3b-b5a5-3422abb2a5d9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "912f542c-2202-4bad-a344-a08571d4f3e1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "77418524-39b4-44d5-b403-baa2591c33eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5fe237b9-b9fb-44d7-8178-6bbcb639c7fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "08481583-dd32-4dcd-8e5c-e7766772b4ed",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-28T01:13:49.2280738+00:00"
},
"company_sector_id": "abb006e8-89d1-44a7-9bfb-b3911f269998",
"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": "07506fc9-0f4b-4b9e-a6d5-5179ba343760",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d25933b8-8325-4d95-8742-0e03d1f389de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "73ec5b69-75c6-4339-abe7-b897cdd80538",
"account_manager_user_code": "sample string 56",
"company_status_id": "aa9c8673-a743-47ac-bbd1-4266c7f533fe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-28T01:13:49.2280738+00:00",
"id2": 60
},
"db_language_id": "f2620c01-3d46-43e7-91ae-8e29746d2200",
"db_language_code": "sample string 7",
"db_title_id": "aa7a8f1b-56c9-441e-b926-88796901c9da",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-28T01:13:49.2436978+00:00",
"create_date": "2026-01-28T01:13:49.2436978+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-01-28T01:13:49.2436978+00:00"
},
"modified_dateutc": "2026-01-28T01:13:49.2436978+00:00",
"id2": 22
}