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": "a2bcc307-ce3b-4601-9011-e479f31b8794",
"_parent_id": "d0996948-680d-4a76-80e3-b583ec8dd93f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4784e571-9ccb-476e-9176-ad37709c78d8",
"company_id": "29c94e28-11a1-4637-a6ca-ac7b6a308c01",
"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": "deff0a4b-bd92-460f-b902-635a8020cad1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "23ba21d7-1dca-49d8-8118-c50b76fedff3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "15376838-b045-4f2b-b73e-957f3c4904aa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7c044557-7ccc-40b4-8e9f-d06a1bc64fa2",
"company_code": "sample string 5",
"company": {
"id": "abe2726f-2a28-4a4f-9874-490784dc414d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T13:55:49.9967247+00:00",
"sales_territory_id": "0ddfea2f-019e-4eea-a866-4e30a1b79314",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c700a053-a5d1-464b-a6ff-177eabcadec4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c588796-3c11-425d-8af8-d0aa1f1c0f39",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b0695eb4-79cd-47ce-bde7-9049188d84f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6630f687-b8af-41bb-98a6-68a21806c094",
"db_currency_id": "b2bb7a80-230e-4841-8272-9df4163dc0fa",
"db_language_id": "23bd49e1-a70d-4a75-849a-09f7b8cbd695",
"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": "2025-09-18T13:55:49.9967247+00:00"
},
"modified_dateutc": "2025-09-18T13:55:49.9967247+00:00"
},
"marketing_segment_id": "9cd16904-e3c8-4f77-93b1-99853f59c961",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "199cd7ba-afe4-43ff-b226-9641a02ff949",
"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": "c3b51e37-15e7-4cba-8ab9-80f0d1484188",
"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": "128dd7b3-139e-4a59-8e4a-d8c7074069ba",
"db_country_code": "sample string 28",
"feelist_id": "0e383f31-fac8-4d52-9618-f47156e18021",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "20ed2ace-a375-49a3-a295-d3fba013bc3e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "59693d93-1113-4f8d-9b39-23f7b766c456",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T13:55:49.9967247+00:00",
"db_currency_id": "ad938dd4-40e6-407a-a5ab-c26026e899a8",
"db_currency_code": "sample string 10"
},
"company_type_id": "663191c0-abf7-4bc5-86c1-6d9234f9defd",
"company_type_name": "sample string 32",
"company_type": {
"id": "b88ff91c-444a-4e09-9c18-f9ea42437bca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd122b1a-f05b-430a-9c22-0243305159c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0cd870c8-e092-4379-b459-7071d7238dd1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f1d88d3-ea5e-4936-8d01-567b1e3b648e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cde2a3d7-b0bd-4d6a-add9-91f05ee252e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3c9d29c-cef5-442b-9af3-f1bd4bdc35c2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T13:55:49.9967247+00:00"
},
"company_sector_id": "f10ec241-b662-41b7-8cdb-3244e84ab142",
"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": "45cd921f-9186-4cae-b58c-51015370c3ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eae4476c-8f2a-4ec1-a496-212c2fd4e0ca",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "34676aa4-19a2-451d-9b8a-479cf546fc62",
"account_manager_user_code": "sample string 56",
"company_status_id": "fb48bb0c-5934-4eae-916d-e819d70980e1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T13:55:49.9967247+00:00",
"id2": 60
},
"db_language_id": "f57f50a9-6efa-46b3-8a24-cb20eed09620",
"db_language_code": "sample string 7",
"db_title_id": "04148af0-ceb9-445e-8997-44cd008e7e06",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T13:55:49.9967247+00:00",
"create_date": "2025-09-18T13:55:49.9967247+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": "2025-09-18T13:55:49.9967247+00:00"
},
"modified_dateutc": "2025-09-18T13:55:49.9967247+00:00",
"id2": 22
}