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": "9ee8d1b4-b119-40c7-b390-3e86f4207664",
"_parent_id": "42cd58c0-0dec-4a10-bc41-3b3e4b120c76",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "25bdc148-cf44-492d-95b0-28da4c54ff93",
"company_id": "6c6d7e73-3f32-47b9-a0ae-f96fe6776ac4",
"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": "7e933da0-22c6-4517-9005-cda943aef129",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0145f7f4-25bc-4cd4-84e6-4fc5d0c81a41",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "82733d9d-c603-4d21-b134-581e8d28410a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "214e438b-3d84-4c61-b109-acfd72f8550f",
"company_code": "sample string 5",
"company": {
"id": "15a4f0d7-199f-483c-98e6-cfca7f7625a2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-03T04:50:46.7609931+00:00",
"sales_territory_id": "48274ace-5492-4b4c-a52f-5ebc82b02eeb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1b7a17d3-1f64-4e2e-9bcb-4cb3089fbf01",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65082b3a-80a1-4719-bfc5-cd499a330fdf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f1179cd-2549-44b2-92ea-acf9b31bb7e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66899a9c-9f84-4637-9a38-8a2177cdcf2a",
"db_currency_id": "abd19bad-5b72-4357-a18a-02e5aa9fafc1",
"db_language_id": "bada81c9-6ba5-4c47-9e81-05474ff6a734",
"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-03T04:50:46.7609931+00:00"
},
"modified_dateutc": "2026-09-03T04:50:46.7609931+00:00"
},
"marketing_segment_id": "52e46d16-07c5-4975-9eb4-fccd94bf8410",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2c2a17c5-1de4-4a4e-ad4d-594163983183",
"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": "a4428f29-a419-492f-992f-51b5fc403a2a",
"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": "da340d9b-8e72-4606-a690-c7563894679f",
"db_country_code": "sample string 28",
"feelist_id": "664d64ca-f424-4c24-8c8e-1ca796d184aa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ce608548-3d8f-48d7-a759-109246ba5348",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6c817eb6-91d6-4f10-a2cc-6508dfed7072",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-03T04:50:46.7609931+00:00",
"db_currency_id": "029ff2d5-d00d-4231-98dc-9f4b921f90c8",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6af0457-d95f-484e-be5a-0c5fdc201eb1",
"company_type_name": "sample string 32",
"company_type": {
"id": "6913216e-b0f4-4ec1-a439-1381a6180bb6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f88b1936-a057-40aa-a0d2-74ca23c5d0e7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "069aaa6e-1925-4f52-80c4-9ae9bab3d40e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2906b6ee-cdf7-4255-8093-4404a09ee662",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fca45492-b49a-4f18-a543-2e6fc496d369",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7a24e38d-2662-4cb6-a0e2-0728a90508a9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-03T04:50:46.7609931+00:00"
},
"company_sector_id": "f8e77411-fd58-4209-bdce-92ba57bc2fd1",
"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": "9e57b733-ed52-42d2-a35b-3cfb66be5626",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "713c5477-712d-4742-89bb-4230271a2d50",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b5acff7d-b991-490b-b459-f84a946d13b5",
"account_manager_user_code": "sample string 56",
"company_status_id": "9a6dfec9-5de6-41eb-b657-f7c960155a96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-03T04:50:46.7609931+00:00",
"id2": 60
},
"db_language_id": "af70f3b7-418f-42c0-850e-207ddb7f84b6",
"db_language_code": "sample string 7",
"db_title_id": "6d170885-0022-4239-acf6-b1b5e8cd68a6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-03T04:50:46.7609931+00:00",
"create_date": "2026-09-03T04:50:46.7609931+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-03T04:50:46.7609931+00:00"
},
"modified_dateutc": "2026-09-03T04:50:46.7609931+00:00",
"id2": 22
}