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": "73800655-5cae-465f-af4d-5ec76e1bfca7",
"_parent_id": "5c830e86-e70b-419c-8096-36cea61aca2c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "320a5997-7d7d-41b6-b5c1-794bb8afbba3",
"company_id": "9ba28981-6558-43c8-b9ea-64b2e2c85d42",
"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": "60228550-1d67-4569-bfe1-d8b9612bf4cf",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cfdcba11-267a-4567-8e60-fb1c7d0af7f3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "59926072-70ae-49d4-9462-a78c47b7c6be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b63495b7-1713-4cb0-bff9-5dd1d47dc30f",
"company_code": "sample string 5",
"company": {
"id": "bec8c4c4-f3f6-4d5e-901d-8bdef018e65e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-06T04:35:05.2247075+00:00",
"sales_territory_id": "549127b8-0979-47df-8c2e-de454cc11cd9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b194124c-90b3-45ec-bb35-c087b1280a72",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "941284d5-c05c-41b1-a6d8-2c0ad367fef4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65b30807-7df0-4735-88f7-714d4f15010c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f93df07-2098-43d1-9598-1f36a1a137c3",
"db_currency_id": "ae1abe48-d3cb-4f2a-a494-75cd803f4654",
"db_language_id": "8b45102d-910e-432f-9ec3-084472f2ecd8",
"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-05-06T04:35:05.2247075+00:00"
},
"modified_dateutc": "2026-05-06T04:35:05.2247075+00:00"
},
"marketing_segment_id": "9e1c65bc-7282-45d4-8f41-e21cf9c810be",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "28d46013-49b3-4db8-ad3c-7ff9c11c3f0a",
"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": "3813bfcb-b6cc-458a-8f8d-b5ad3830dc1f",
"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": "a9cac7ad-7ca2-4635-a702-12482adb3c6a",
"db_country_code": "sample string 28",
"feelist_id": "71418f05-0076-46e7-a35a-07539b34ba7d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b21ab34-7b76-443a-bf49-c6e514c68876",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7778d540-c7a5-45f8-85f9-4e920674f8b5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-06T04:35:05.2247075+00:00",
"db_currency_id": "f2ff3537-4b01-4205-8a80-dbf335e4aeca",
"db_currency_code": "sample string 10"
},
"company_type_id": "9f4d8f67-ef60-429d-a504-4a96df3091fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "261fbf35-49d6-4ed3-93e0-8a7737f4ffb5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a018a1d1-c77d-4b2f-a883-5e8d4e4d41b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d2c6ddb-6126-4e95-bcc2-673805939f8d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e07cf1b2-6fae-4f22-9d1e-a41385a09b8f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2375bf2-96a7-4ee2-8860-027f9b396b06",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5b18495f-47e7-4ea4-8025-98a58d8faa01",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-06T04:35:05.2247075+00:00"
},
"company_sector_id": "89eaf2ab-f366-4daf-b1fc-4d183db652fe",
"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": "c27cc964-4467-47df-8eb5-1645be251807",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dc1da54f-8f79-4659-a4fa-1a249a28a030",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b4ddbf28-bad4-4419-8268-a2a96a7a67cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "9e8f86a4-3d89-44ad-a5d3-fdfa425edd8c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-06T04:35:05.2247075+00:00",
"id2": 60
},
"db_language_id": "0a7ad0b0-2a8e-47ef-8d20-d2bc1f36240c",
"db_language_code": "sample string 7",
"db_title_id": "909fe1f8-67d3-4abd-b3ab-1f160b68e239",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-06T04:35:05.2247075+00:00",
"create_date": "2026-05-06T04:35:05.2247075+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-05-06T04:35:05.2247075+00:00"
},
"modified_dateutc": "2026-05-06T04:35:05.2247075+00:00",
"id2": 22
}