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": "8160e09b-49f4-4893-84c4-e8cd29dea0d3",
"_parent_id": "19171540-0634-4d71-86af-c199946953aa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6b13e4c0-0f56-49d5-9733-539fe0254f9b",
"company_id": "9f5378ab-43f6-441f-87af-0dd9b7b25967",
"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": "c6257de9-012e-49fd-a933-7996f0b442b5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a7f36f72-5f79-4260-a24d-64335b34df0e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "74358968-400d-4053-b2af-7e6fe0d156bc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c516545-e6c8-4597-b601-bb042048c7c2",
"company_code": "sample string 5",
"company": {
"id": "e35fba54-0683-4523-b184-ae6b576c59a0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T15:17:09.8526839+00:00",
"sales_territory_id": "24c84d6a-c1ea-4429-8f5d-f98e592972b8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "78745f83-deba-41cd-b4ed-fb0e3986a803",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f37609de-0197-476f-968a-b58115642db1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a9113bc-7def-437c-ad28-67cdb5b3d479",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "478a22b0-ffea-4845-86dc-e6cd2bbe5d67",
"db_currency_id": "c92eadc8-24e8-4507-8ff2-c334a9774742",
"db_language_id": "88e0a369-9721-44d8-9289-65a6dd5c1352",
"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-07-23T15:17:09.8526839+00:00"
},
"modified_dateutc": "2026-07-23T15:17:09.8526839+00:00"
},
"marketing_segment_id": "c4c07533-fb33-49c1-a114-560f01ef1093",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6dc08c05-f9e2-4386-a78a-fc66c3c2ebd3",
"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": "0fae76c3-7c4f-4d41-ab3c-1e4e9cb3af9e",
"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": "f8270260-0448-4fa8-a14d-5e628808fa3e",
"db_country_code": "sample string 28",
"feelist_id": "60d8f441-be24-490a-ab0d-e9a775e94517",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "db6911fd-3c24-48d2-a849-f6ca83a05723",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b775db2-fa8a-49f5-b689-586e0fd2f9d9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T15:17:09.8526839+00:00",
"db_currency_id": "60782544-618f-4f0f-8453-6f7df17bfe3b",
"db_currency_code": "sample string 10"
},
"company_type_id": "08b3dc4e-5662-41e6-95e4-12011f60d579",
"company_type_name": "sample string 32",
"company_type": {
"id": "39ea2a11-8dc6-48fb-9794-f2ce91da40fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d5d3bf6-291d-4a2b-9315-c99cbf74cf40",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f04c3255-51cf-40bb-9700-6dbd26261713",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "178a6083-2a6a-4fa9-9a8c-9f9042a49724",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f01c38d2-b6fc-41ca-97eb-a17c6a579c3f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d46ede37-6ac8-4737-8aaf-c8108a13e21f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T15:17:09.8526839+00:00"
},
"company_sector_id": "d5db318b-c453-40d8-9496-2bf957f76539",
"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": "4f159811-523c-46b3-9651-0a86e4b59a3e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eb044cde-e314-45b3-852b-013bb597e24d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b42e6497-e832-4a84-bd98-2227b1339948",
"account_manager_user_code": "sample string 56",
"company_status_id": "a1e34dfa-7f61-4462-8530-7c39a3c11239",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T15:17:09.8526839+00:00",
"id2": 60
},
"db_language_id": "d5e5cc75-1f63-42d1-9a69-04e833daf758",
"db_language_code": "sample string 7",
"db_title_id": "dd469a81-0922-4ebc-a85a-671b4197afa3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T15:17:09.8526839+00:00",
"create_date": "2026-07-23T15:17:09.8526839+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-07-23T15:17:09.8526839+00:00"
},
"modified_dateutc": "2026-07-23T15:17:09.8526839+00:00",
"id2": 22
}