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": "3e606ffa-3567-4047-bb84-a63466f8de96",
"_parent_id": "cdd43538-e4a8-4473-be59-2042958a1de0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "019a12a9-7c85-4ca4-94f9-92d27ec4fe27",
"company_id": "84203b03-0fd8-4837-97d6-64b21d4fedf4",
"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": "5a368d64-67d7-4ab6-8802-b84156bbd12f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "95aacae5-ded8-42f8-9855-9dc3aa870390",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3d99bc77-761f-4884-a0d5-6ac93115fb2c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e4644783-dacd-4907-837d-4f930a3c1335",
"company_code": "sample string 5",
"company": {
"id": "ab9a86cb-6958-40d5-b982-afe647d3ea37",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-17T16:17:26.3687903+00:00",
"sales_territory_id": "518b9b90-caeb-466c-8218-2a1cf937f222",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22808e7f-52a9-4395-804d-3d2f91391556",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6472544b-f6ce-423b-bfc2-80809b8cfc67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "29f9f2ab-21e6-4ff8-b90b-77a6253920eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f239fda-f985-4f56-a629-8fafff51a78a",
"db_currency_id": "58dfe032-db37-4d00-acbe-b02b27593386",
"db_language_id": "d63b6d77-747e-4db6-b085-c4581f02e7d8",
"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-07-17T16:17:26.3687903+00:00"
},
"modified_dateutc": "2025-07-17T16:17:26.3687903+00:00"
},
"marketing_segment_id": "63b20a21-f572-4f16-8bef-d6f2ecf05ff3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9c956cea-8264-4a05-8c1d-ddd4b46ac85f",
"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": "2c17b61e-a49b-4781-8e53-c20400e7f6b8",
"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": "f7883871-e8b8-46b0-9a4a-57106ff98a0f",
"db_country_code": "sample string 28",
"feelist_id": "acc1cb9d-6de8-412f-bc47-8ed58946738a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a6171dd0-2d89-4a12-8f82-75eb21f5e23c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a5fbb5ee-34eb-495e-aa95-5d8cf11af67f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-17T16:17:26.3687903+00:00",
"db_currency_id": "7e1f6c19-afd3-4406-97a5-c06d6d09a8e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "b7b7de8f-0ec0-4bee-b34b-61b29653e2a7",
"company_type_name": "sample string 32",
"company_type": {
"id": "30b02361-2856-4884-908e-49b645025ebf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "516a9166-a915-4812-97be-f8eed02392a1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e56480a3-2c6d-4258-baab-dbe35e6a8717",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "de291e7f-102e-48a7-896f-ff6edb4efce7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "79c6dd91-63f7-450b-9b58-1499a013c291",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8c86582d-7114-4478-be45-cf8925c58a27",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-17T16:17:26.3687903+00:00"
},
"company_sector_id": "7bdf8065-af9f-47d3-9cd0-c9be64cc63b0",
"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": "3634c9f9-ab23-46b0-b865-507d81ce4529",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a90b1541-616e-42fa-b5db-a2c330d44efd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bba8f441-49af-4407-8b2c-6d80d6ac3c96",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1b84e05-0276-4dde-8b2c-b43d6b67f7c6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-17T16:17:26.3687903+00:00",
"id2": 60
},
"db_language_id": "ffd43bbd-bfc4-4ec4-9f8d-ca17e7f15185",
"db_language_code": "sample string 7",
"db_title_id": "7218eab1-b6f7-41bf-bd4d-d8343b828cb9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-17T16:17:26.3687903+00:00",
"create_date": "2025-07-17T16:17:26.3687903+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-07-17T16:17:26.3687903+00:00"
},
"modified_dateutc": "2025-07-17T16:17:26.3687903+00:00",
"id2": 22
}