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": "b51db88f-47fd-40c8-886e-c3e34c2b948f",
"_parent_id": "e14f9467-bf46-4ba2-b54c-d24518ebf335",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "98bbc06a-3d95-4511-b51d-726985fbbd94",
"company_id": "c8408044-ed11-41fc-9b3c-c8fc67a8469f",
"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": "11554094-c9a2-4c0c-b5ef-9c003970d12c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e3eee85b-37b3-4bed-81f7-7368d2c445ea",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5a0f28ed-5221-4840-833e-0ee51c77bc26",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a673bbbe-b705-44df-a109-648d03f3868a",
"company_code": "sample string 5",
"company": {
"id": "d05a90d2-fec2-475e-9ec7-a722489f3210",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-27T05:10:06.6866947+00:00",
"sales_territory_id": "ad6c7707-ec64-48fc-a105-5316e9d85d7e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "95c02b9a-91c4-4951-9303-d89d65a935b5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fcb6461-bcd7-474e-a01a-3ee426b435b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "613cbaa0-278b-44be-8841-99967a5b5c13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5b0bdee-c797-42f2-8490-83dd21790e45",
"db_currency_id": "b7ca4f26-b605-4c07-8219-ecda4bc45fff",
"db_language_id": "ada4d7e3-d69b-4892-894c-22c10289ba1b",
"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-10-27T05:10:06.7061183+00:00"
},
"modified_dateutc": "2026-10-27T05:10:06.7061183+00:00"
},
"marketing_segment_id": "457a7bf4-56f6-4e62-88f8-911009a4503e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3fa5553f-d16a-4be8-8bf3-c13244f738f6",
"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": "f33bd845-e132-47b8-8dc6-72c83bbfbb0e",
"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": "aeee8d39-8093-446d-b968-18027b67a854",
"db_country_code": "sample string 28",
"feelist_id": "a1dab6e6-9d9c-4595-a274-bc7ec605d285",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e5e15194-d61c-40b3-ba7f-82fa2799ddfb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "181a7391-3cf7-4f67-8b25-51ccd8ba9c7c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-27T05:10:06.7061183+00:00",
"db_currency_id": "712e271e-e8e9-4bf5-a516-c1ef0bf745b0",
"db_currency_code": "sample string 10"
},
"company_type_id": "b9095f73-024d-487c-9b2a-7a501e72479c",
"company_type_name": "sample string 32",
"company_type": {
"id": "aaae7b95-122c-4d78-afbd-064618dcc713",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7ce5a02e-63fc-4c2b-94ca-ef4dad811879",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2b40e8f4-1d51-4889-abc8-c3ad9021e416",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7a649cf5-4fda-46e8-8a4d-54e461aad1cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "825fa63f-6f8b-4589-bcc4-ae21b959c615",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "317e1763-7b85-46cf-8000-8a482071c65a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-27T05:10:06.7061183+00:00"
},
"company_sector_id": "8f8994e7-c6ef-4e53-85b6-0e97bd405d6f",
"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": "2a2a30e4-9d3b-483a-9d0d-540f5c482db3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "562b8bc5-472f-4400-a688-ca0776399720",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "96d15d1c-3ae5-4202-a3c5-666bd1538f04",
"account_manager_user_code": "sample string 56",
"company_status_id": "296fbeac-aa67-4b2b-a5c2-509466cc7128",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-27T05:10:06.7061183+00:00",
"id2": 60
},
"db_language_id": "04472ae1-2df7-4d4b-a555-eba1f96468f7",
"db_language_code": "sample string 7",
"db_title_id": "06eb3022-24b2-486e-9324-08b6f937d2b9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-27T05:10:06.7061183+00:00",
"create_date": "2026-10-27T05:10:06.7061183+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-10-27T05:10:06.7061183+00:00"
},
"modified_dateutc": "2026-10-27T05:10:06.7061183+00:00",
"id2": 22
}