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": "bcf914eb-ed35-4f59-b7ab-0aef4b2d1102",
"_parent_id": "ce90ca29-84ef-4854-b594-c14d8de8d504",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "40239eae-d64c-49a2-b8a4-a4bee09f4b46",
"company_id": "805cf5a5-83ca-49d5-976e-fd83a6768825",
"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": "be8c04b6-d679-4a69-bffe-2e5cca55609e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0687e9be-af2b-4740-a6cc-477eea3fbd84",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ebe1260b-f49d-46d2-a4c4-25e6ecb0b84f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2b99e4c4-bc78-447e-b75e-a92be8d787f4",
"company_code": "sample string 5",
"company": {
"id": "095dfce5-a105-477d-b1c0-8034a5a9e8cd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T21:25:14.3615805+00:00",
"sales_territory_id": "67417984-a913-47bd-bb7d-b723b4b0ee09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "712f339a-13ff-45a2-a03b-ff5fdc6e20db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5f81dab-d9b0-43fe-93a4-f9b6d31cd102",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca7b6a9f-3f92-42dc-b74f-9939abee6a94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49e83067-282b-436c-aa7b-73f616bc6728",
"db_currency_id": "098cd725-76b3-41bb-8573-45551c0b78cc",
"db_language_id": "5f0054a3-cebd-4e2a-88ab-7a90237693f5",
"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-09-30T21:25:14.3615805+00:00"
},
"modified_dateutc": "2026-09-30T21:25:14.3615805+00:00"
},
"marketing_segment_id": "9c7f8d90-35c4-4704-a896-3194392c9029",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4188b864-a03d-4c61-beb0-3897c4d01111",
"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": "bd8f0fd8-267c-40e9-8634-6e8e272408ef",
"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": "51c2704c-b376-4d34-865e-077f9d864a90",
"db_country_code": "sample string 28",
"feelist_id": "75d93384-f34a-4f1c-b2c3-25fff8d2e248",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4dae43ee-9cb8-481f-adcd-3234866a91bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98e36e17-0036-4a96-95e7-d3f3e5d93f86",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T21:25:14.3615805+00:00",
"db_currency_id": "d20b39bb-07ac-46e1-9ed2-56d6408f9ea5",
"db_currency_code": "sample string 10"
},
"company_type_id": "a63a27d0-15cc-4321-bafd-72a6d510ac7e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1d42b7b2-49c0-41bc-883e-f3ba6c433ef9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "168d4ebc-2ed3-4125-8e59-2871f37e5eed",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6ad2898b-9719-4170-8cdc-b15819fdbe02",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bbcb0395-8e4b-4d03-9587-6ef975f5d7be",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b0dcee98-2848-4ec9-a8b6-eea26103d81d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "89e10dfa-20f3-4cb3-b1c5-ca384ac0e20d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T21:25:14.3615805+00:00"
},
"company_sector_id": "45e9d145-3db8-47bf-8d2e-900a83cd2b46",
"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": "fa0f412d-3ea9-441a-b3aa-9aa31ec317ac",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b46f0d1-c70a-441e-a611-f10c767445cf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7684b14b-f7b3-4bca-bc5c-826231198347",
"account_manager_user_code": "sample string 56",
"company_status_id": "ec084a1a-c0f5-417f-8a73-0805aabee326",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T21:25:14.3615805+00:00",
"id2": 60
},
"db_language_id": "5fe9fe1d-f282-47c4-a59c-cf15ab8ec772",
"db_language_code": "sample string 7",
"db_title_id": "34ecee4c-a223-486a-a5f4-b710aa97ffe9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T21:25:14.3615805+00:00",
"create_date": "2026-09-30T21:25:14.3615805+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-09-30T21:25:14.3615805+00:00"
},
"modified_dateutc": "2026-09-30T21:25:14.3615805+00:00",
"id2": 22
}