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": "417b1aa4-c2d6-4298-91f1-c79a8aabf5e7",
"_parent_id": "9e5199c0-fff2-4ec2-92b2-ae0f022493bf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b897b0a4-67b5-4943-8907-91119566d2b8",
"company_id": "b3a05a5d-c269-4229-9bcc-625bf87f58d3",
"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": "ac2190d4-0a33-4ad0-a710-c2366d06cbbc",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "64602809-6eee-47fc-840f-804800b0fdc2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d34549aa-7f0d-427b-afa5-4c1726a353df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ad21cacb-b41f-4ffa-b40b-4e32845d41da",
"company_code": "sample string 5",
"company": {
"id": "815615ae-dccd-4518-996d-7fb6389c9641",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-09T21:32:02.198982+00:00",
"sales_territory_id": "a23eb7ba-fc53-4a13-a5be-eea0ee346735",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2f674ce7-3723-46e1-9585-7d7f7fb41e5a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0728169-e1c5-49b1-81dd-088fb062b127",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57c24aa9-a2b4-4b0e-ba46-5b5591a03727",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05dbcde2-6af3-4698-b5df-6bfe4a58ea38",
"db_currency_id": "9e20d4b9-660e-4c31-a5f4-6ad4427faa22",
"db_language_id": "504d00ec-5e18-409a-bebc-ad050063cf0c",
"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-10-09T21:32:02.198982+00:00"
},
"modified_dateutc": "2025-10-09T21:32:02.198982+00:00"
},
"marketing_segment_id": "e38fe9fe-1476-4c1c-93e0-d034520936f1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "97ef6d16-f266-403d-99b6-28c2397beed8",
"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": "6eb98d1e-36e3-432d-ae1c-89f5003d23a5",
"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": "b155a8c0-7705-4885-a7a0-39a0e2402a79",
"db_country_code": "sample string 28",
"feelist_id": "adca8df2-3e62-4bee-acad-cd540bb4847c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a06b2721-b3d2-4faa-b059-55418b04fddb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69de2479-49c1-4a2a-a2c1-4868b615ad7d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-09T21:32:02.198982+00:00",
"db_currency_id": "91359052-798e-4369-9ee8-aa498ddb179d",
"db_currency_code": "sample string 10"
},
"company_type_id": "fbc99371-12f8-405a-b879-210511a90839",
"company_type_name": "sample string 32",
"company_type": {
"id": "82dee7fc-4d94-4afa-966b-1bae271f6638",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc8f34a6-9752-41fd-a4bb-90f53bb4ad48",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2ebd37ee-d47a-4361-9c3b-27c530875499",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94a92ace-4485-4dba-b69b-873dda33f3f3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7ec2132c-5815-4d9b-ba3f-5587e2d90fdc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3aa32746-01f2-4cd8-8fec-ce5e41405a49",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-09T21:32:02.2146072+00:00"
},
"company_sector_id": "e4229f90-0d7b-4894-9085-8b17c06bc7ac",
"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": "967a0129-382e-4b73-9c8c-b7ff1fd26a94",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "911e06ac-b343-402e-8a42-93863b9a6b1e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "12854d44-700f-4023-9cf7-b564a442b192",
"account_manager_user_code": "sample string 56",
"company_status_id": "79b87d4d-177d-412c-983a-293b0cdae5a7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-09T21:32:02.2146072+00:00",
"id2": 60
},
"db_language_id": "09f9fa93-6c38-4888-8c72-c53bd1c88e88",
"db_language_code": "sample string 7",
"db_title_id": "d78c8ceb-e78e-4d63-a434-e79970f82f2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-09T21:32:02.2146072+00:00",
"create_date": "2025-10-09T21:32:02.2146072+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-10-09T21:32:02.2146072+00:00"
},
"modified_dateutc": "2025-10-09T21:32:02.2146072+00:00",
"id2": 22
}