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": "c4c218ce-3405-491e-9e35-4d1bb2b65708",
"_parent_id": "461574ab-6147-4c67-b175-019e0ce6fd80",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5075633a-fd93-48ed-8602-0f11cc42344a",
"company_id": "ad264911-f9c1-400d-a614-955935580b40",
"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": "f3771094-ee6b-4b4d-963d-e82be769b0c9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0dc2f5a4-6e07-4a61-9c1e-0fb7dc5744ce",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c6c7cc31-481e-4368-8a01-9e42f812f5e1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cbfb6b72-c0f9-465b-9e73-fb2943843ffa",
"company_code": "sample string 5",
"company": {
"id": "c1cfea85-09a3-4475-bba5-103288cc86bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T20:46:32.2664719+00:00",
"sales_territory_id": "183676ee-724d-445f-8052-f71bd08eff55",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2be8e607-20e0-4066-852e-59b8442f0466",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97d3ae58-7261-4dc7-84c0-ff15cf99c9d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34c3b7dd-4651-4aec-a62e-565bcbb16076",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb93b9dc-2b57-4be4-a20b-eb0aaa78e0d1",
"db_currency_id": "b70c8a61-27da-41b3-88ef-a09fa3bce311",
"db_language_id": "425af245-3697-44a9-b82c-a6ff3cd75449",
"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-04-03T20:46:32.2664719+00:00"
},
"modified_dateutc": "2026-04-03T20:46:32.2664719+00:00"
},
"marketing_segment_id": "0cce5641-d069-46a7-a840-959c198a3000",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83f016b9-c1be-4ffa-a2f5-95c32275c454",
"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": "516db914-0d38-4579-8ac3-4957f49c1b44",
"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": "22dba733-9494-43b7-b8c2-636683801d47",
"db_country_code": "sample string 28",
"feelist_id": "586a605a-d769-4b80-8e48-fc9866f1e3e7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d521bdb8-540c-4c13-bfe7-5ddc95dfad3d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74d5c4f7-3b5e-4873-a99e-be0ed0be4525",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T20:46:32.2664719+00:00",
"db_currency_id": "5fd1c292-0462-43ee-9a1f-e9dcc1ea1663",
"db_currency_code": "sample string 10"
},
"company_type_id": "b852f18a-38e2-4a1c-829e-fef564e67325",
"company_type_name": "sample string 32",
"company_type": {
"id": "72ae5b6d-286d-48a1-92bd-1a7d5b9d4d9f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa96ca1e-8428-420a-8418-01d4c88ecaa7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ca6fd95c-b3fa-4b8e-81e1-5b951620bba0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7af0e27a-bbb9-4a21-a9a6-b29569dc4a6a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "045c35d9-4254-4182-8015-4b5f441403d7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8c42348-d999-4775-b655-d633d065fca5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T20:46:32.2664719+00:00"
},
"company_sector_id": "8a2584bb-ff27-4477-86e1-f3a44793e43a",
"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": "db26a4c8-1023-4fbe-a398-3b6e92deb510",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e7bb60a-f233-4a38-992e-d92f30812a94",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e090489b-5580-45fb-b491-cc74dac994cc",
"account_manager_user_code": "sample string 56",
"company_status_id": "1af2cf25-a8eb-47c8-958a-b29fe3176e20",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T20:46:32.2664719+00:00",
"id2": 60
},
"db_language_id": "7ecc2887-7198-438a-94f6-3b6d1d28348a",
"db_language_code": "sample string 7",
"db_title_id": "2661ae32-eef1-4875-a2e4-7b98f76af95f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T20:46:32.2664719+00:00",
"create_date": "2026-04-03T20:46:32.2664719+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-04-03T20:46:32.2664719+00:00"
},
"modified_dateutc": "2026-04-03T20:46:32.2664719+00:00",
"id2": 22
}