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": "c3d402d8-60bd-46ca-9adf-d0aedc1bdea6",
"_parent_id": "bc7de868-d596-46bb-bb56-d76921554616",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "db6c1350-8aa8-4676-90f3-fc8ae3778999",
"company_id": "122fc59d-b1ed-4033-80db-8c7f998c6fc8",
"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": "49016518-284a-46b6-8971-0360254354eb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5bb34500-fecb-4600-af57-01cba8127b7d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ae8fd385-02f6-4e46-8c36-733cd8b80afc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a3991a8b-c2b2-4f20-b7de-16b173d88777",
"company_code": "sample string 5",
"company": {
"id": "8612ec9c-73eb-444c-997c-02c5dbbebbfd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-11T06:59:05.5090457+00:00",
"sales_territory_id": "d5bb733c-b355-47de-ae4e-5e172395914f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6b7704be-2e61-4e13-bac4-7962d687f007",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81da0f50-48a8-4199-a211-2a7261de3223",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bbd3b777-0cdf-4d93-b94a-b981705932a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e451c937-a9fb-450e-ab58-4b3e9a5e0b81",
"db_currency_id": "12949541-5c0c-402a-ad46-3438bc36aded",
"db_language_id": "a65ae16c-8cb8-467f-a908-3b9cf92809f6",
"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-11T06:59:05.5090457+00:00"
},
"modified_dateutc": "2026-07-11T06:59:05.5090457+00:00"
},
"marketing_segment_id": "7d2751d3-d1c5-4985-b065-0310d3fbc3d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8c3d72e-63e8-474d-9f2f-85af173e81e5",
"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": "608fcb5d-9864-4cbb-9890-7852b3273632",
"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": "89c89f48-c921-47d8-87b9-d15a276619f0",
"db_country_code": "sample string 28",
"feelist_id": "bc61aa97-e546-4cc2-a7c0-088fabeee9da",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c2e0e96-3a19-4b1e-9deb-c7270c91ca08",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "77901972-b9c1-4892-8ef9-4f031e80603e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-11T06:59:05.5090457+00:00",
"db_currency_id": "15515237-8b0e-46b1-a78f-a4df987ab3ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "b1c72c64-9be4-404b-b298-7c62f0fb749d",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae0020a6-eae0-48e7-ba5c-ca46a933e7fd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2cb1662-db7c-48e5-b72a-09a87495cb76",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a696fa1e-48c6-4721-8bc7-51a84961e11a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "56fde143-38f8-4272-a5f8-2835f52423ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7db11af9-3c19-47fc-af6c-12c05416b1b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c62485cc-3572-48aa-a7a7-12c7c46102ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-11T06:59:05.5090457+00:00"
},
"company_sector_id": "c1456ee2-fc68-45fa-90cd-ecd6278db2da",
"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": "36a95529-682e-4d4f-ad41-2eaaa565189c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6b1322ab-9d82-4115-82b2-1f2c9be4968d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df13eea2-58b6-4d08-8a19-af816ab4ad41",
"account_manager_user_code": "sample string 56",
"company_status_id": "e727c2bb-bb7d-4a14-8718-ef2a455eade3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-11T06:59:05.5090457+00:00",
"id2": 60
},
"db_language_id": "97e60593-53b1-4611-98f7-8829150f4539",
"db_language_code": "sample string 7",
"db_title_id": "1b4f38ea-dd20-4f3c-b708-993562bd975a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-11T06:59:05.5090457+00:00",
"create_date": "2026-07-11T06:59:05.5090457+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-11T06:59:05.5090457+00:00"
},
"modified_dateutc": "2026-07-11T06:59:05.5090457+00:00",
"id2": 22
}