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": "2d8a071f-2de4-4936-aeea-41b31485f9d5",
"_parent_id": "a956fc33-66be-4622-9bf3-32676a40faa8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1a87d858-37ae-4e35-9bee-c0d48d33f302",
"company_id": "25f86ed9-05e9-4710-937e-0ce756f41893",
"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": "99671ecb-527b-4c7c-8aac-1c1e2d2b3f78",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "341050dd-b4f6-4185-aec0-57db5bb83a10",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "62597281-444e-4e58-b184-6c999afff6b3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c8ea35dd-20e6-4699-b908-c444a00f4ce6",
"company_code": "sample string 5",
"company": {
"id": "0ecd1ec8-2359-4a8a-b10a-f8ffede2ce7c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-31T15:13:38.5355961+00:00",
"sales_territory_id": "8383238d-f82b-4001-a6e7-f29d3161a946",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "96b25b0a-6d00-4022-8c97-6ba870443da3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "33db7566-3c0d-424f-841f-85f505a2a0fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e33dce0-fd48-49aa-9e92-b37c12358b48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a7d2553-b40d-4fab-a695-a0adbe793479",
"db_currency_id": "507443cd-6833-4ba0-8268-b5085cdb9553",
"db_language_id": "124e7a22-3e68-48fc-9509-6ab79a2d6058",
"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-31T15:13:38.5355961+00:00"
},
"modified_dateutc": "2026-10-31T15:13:38.5355961+00:00"
},
"marketing_segment_id": "73e906f6-e2b1-4af7-b3b5-be5e72e23350",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5e532ee1-e6b9-4d6a-9afd-720ed42a3f4f",
"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": "12417fe0-839e-4356-842e-ab5eab0ba002",
"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": "01980b7d-3346-43ff-a88d-78450aa833ad",
"db_country_code": "sample string 28",
"feelist_id": "3550dbb5-a1eb-4321-a22c-f45feac742dc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6c921619-9fb8-48a0-afe3-c3800e577207",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "07b0b4ef-7cea-4534-b36a-ab21dd59a9f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-31T15:13:38.5355961+00:00",
"db_currency_id": "2c68dd33-6cb6-4ae2-bee7-38003265f7a0",
"db_currency_code": "sample string 10"
},
"company_type_id": "ca00a2a3-4a62-4d73-8fe3-9fb539719c2d",
"company_type_name": "sample string 32",
"company_type": {
"id": "c1141d97-d23c-4077-a3e2-e088b53059db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a3ccf5d-a69f-4eec-9edb-bfc9bafe575c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "31e61b29-b3e0-479c-8d7e-ca6e76b6722b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e3e7f9ac-c3b4-49e2-b7d6-40c826a4501a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d8adcf91-8ef4-4318-8689-c5208b35eb77",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0d4c1a24-9836-49b6-bd4e-42cdaf602f03",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-31T15:13:38.5355961+00:00"
},
"company_sector_id": "30fc7c5f-047e-467d-b395-b886ae9e7ce1",
"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": "830f52ab-2dd4-4151-8ed5-39b7d667db74",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6017b27a-3539-4db8-8cf2-a27796b7a13f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77a590cb-6e15-40a9-98a6-9ff383b7f9d1",
"account_manager_user_code": "sample string 56",
"company_status_id": "13e039fa-02a5-4268-ab3a-1fc11bdd2018",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-31T15:13:38.5355961+00:00",
"id2": 60
},
"db_language_id": "41494b4b-6f17-4624-b4e3-d38aa0401c0a",
"db_language_code": "sample string 7",
"db_title_id": "4db922bb-493b-4fc3-936e-81c0f2536bde",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-31T15:13:38.5355961+00:00",
"create_date": "2026-10-31T15:13:38.5355961+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-31T15:13:38.5355961+00:00"
},
"modified_dateutc": "2026-10-31T15:13:38.5355961+00:00",
"id2": 22
}