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": "d34f5068-bbef-44c8-bc29-82f55e3ba62b",
"_parent_id": "826bcb36-be72-495f-89ed-e03ebdfbfa80",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "53c2ccf6-f63c-484f-94ac-da32bedb1990",
"company_id": "8e22af9a-df6b-4cbc-95f8-b1ea044ee953",
"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": "b1b7eda6-0d32-411f-a0f6-291995abaab3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "311e5aa1-e90d-4920-a4e9-3885495d26e2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e0cdbd1e-db48-4fe7-abbf-91619afbe206",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d3495f55-84d9-4752-8dd0-7dfaea1f10d6",
"company_code": "sample string 5",
"company": {
"id": "a0e5d31d-8a7d-4e95-a78d-4256014881d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T15:17:45.4742415+00:00",
"sales_territory_id": "a3f5fe40-57e6-4065-8f85-d84ca034be37",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d677a2f3-441e-4b6d-89bb-d4fd98fb3061",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0df41fbe-d98e-47cf-8af7-a967d6ef6e4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fbc7acd2-5cbf-47c9-854f-fd1579e15dd3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdb0a0ba-257f-49a8-b2e8-b5b68ace5282",
"db_currency_id": "8e4e3a77-c8b7-4107-b88f-8719fcad6acc",
"db_language_id": "489e539a-7f7d-4666-8677-abfaba6bfe98",
"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-02-16T15:17:45.4742415+00:00"
},
"modified_dateutc": "2026-02-16T15:17:45.4742415+00:00"
},
"marketing_segment_id": "8bfa0977-9337-4e58-bcc0-ea8f34435267",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1dff6010-bfcf-46f5-8518-2c33e3a89181",
"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": "91ffceb1-f851-42d2-aa24-7116d186ed94",
"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": "26cd75cb-144c-4170-b19b-abcea5007c15",
"db_country_code": "sample string 28",
"feelist_id": "43539019-26e5-4cc1-ba91-6fb8ac460a74",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b3af232-5e31-47ee-aac1-f593c57d0624",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "edf6c925-1731-4b96-bf66-4517ecf10b37",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T15:17:45.4742415+00:00",
"db_currency_id": "3235ac23-a8e0-4984-ba95-d645f707cd4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "36b98ee4-1cb0-47f4-9f80-c88fda31186f",
"company_type_name": "sample string 32",
"company_type": {
"id": "8159ae36-7970-4bb4-ae3a-a3fbbc3dc754",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b69dee74-f681-4f89-a818-424a8366f6ee",
"sales_organization_code": "sample string 5"
},
"db_language_id": "27bcbfc9-a8f3-458d-802e-cd19353109bb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6d81f4c5-2a8a-4291-9883-278bddfcaa2a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3293c40f-d30f-4d4a-90b2-d63f83c47e57",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5fe31456-112e-4625-abfa-2d3943e17559",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T15:17:45.4742415+00:00"
},
"company_sector_id": "77ddeb2f-ddbf-4936-8f2d-fcde017a0cce",
"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": "6a86e1ba-fa1f-4130-b977-0d010faadb43",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "231d1f46-780d-4190-a1a3-92a363444b98",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cae20441-c980-4eab-b47a-b47009c88246",
"account_manager_user_code": "sample string 56",
"company_status_id": "b89bb70d-1e14-427c-a55f-e31b371a772c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T15:17:45.4742415+00:00",
"id2": 60
},
"db_language_id": "16f8d7e2-cb60-439a-84ff-106387def822",
"db_language_code": "sample string 7",
"db_title_id": "e4b4374e-3593-478a-be44-5e74e49b0a55",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T15:17:45.4742415+00:00",
"create_date": "2026-02-16T15:17:45.4742415+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-02-16T15:17:45.4742415+00:00"
},
"modified_dateutc": "2026-02-16T15:17:45.4742415+00:00",
"id2": 22
}