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": "d2782edf-230d-4542-9778-439a7cae2c07",
"_parent_id": "918e6712-9b99-46d7-a7d3-484a1ed75540",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6c20182e-9648-4740-848b-7607f9ab3395",
"company_id": "c15ee416-26a8-4edd-a835-76413314039c",
"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": "98cfd665-1090-46ca-908c-d2999665345b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a3d92085-e4d6-4e3a-abf7-4e108e5fc522",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "24acf4a6-fd28-4955-a33c-b35677011d6a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0eb1bf7d-1c71-4061-9d6a-2e731ce3b95f",
"company_code": "sample string 5",
"company": {
"id": "f57909b5-82ce-480a-aaa9-d118d63a03df",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-05T07:28:15.8433285+00:00",
"sales_territory_id": "63994a89-efbf-4c28-9878-4487ee6433a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b6fd8477-a034-44b1-bbe2-4221462bbeba",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50269fdd-499b-43d2-9cdb-004762bb1ba8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06efef12-42d2-4657-b527-cd0d8751fba5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2457a5bc-b082-4641-8e99-2edb222645c0",
"db_currency_id": "6301f19f-99da-48a7-be98-2286a61b18c8",
"db_language_id": "9ef25bb4-3fd8-482a-b450-3f228753976f",
"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-05T07:28:15.8433285+00:00"
},
"modified_dateutc": "2026-09-05T07:28:15.8433285+00:00"
},
"marketing_segment_id": "4a45e821-1531-4917-a992-59d8337e391c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dcf1781b-b6fa-4d49-b35b-5d941225709a",
"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": "b6cbc40d-124a-4d8e-a723-1d0c652366ea",
"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": "5ce4bbae-2db3-40c4-a30f-e8bf0b742470",
"db_country_code": "sample string 28",
"feelist_id": "53c3c725-c3bc-45e2-9bb2-18c782f80677",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b070f130-3fea-43a4-af65-351d0ebed817",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e3cc6d0d-23bf-4fe6-850a-94699d6085d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-05T07:28:15.8433285+00:00",
"db_currency_id": "82aeb18e-d8a1-404a-a796-e3bfe7e1d952",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ef3a7ca-7460-4f50-8bc2-bd128d80ddfe",
"company_type_name": "sample string 32",
"company_type": {
"id": "a3a1a2b7-c598-4d65-9d89-52b771ac742a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91df54b6-ecc9-46ef-986b-20306c3c32f7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8956f360-1c83-481a-9965-4c88db5fd335",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "759a3cb2-c2fa-4455-8143-47b3282ebb6a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cda4f285-6874-4082-bad0-706479b071f8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ae456e6a-f3dd-4c60-8648-b8ee2ef5660e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-05T07:28:15.8433285+00:00"
},
"company_sector_id": "87bbc107-f158-4dcb-b327-12c7c26fc79e",
"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": "8c37fcbb-7aa9-4781-85d1-d41118ba3c2a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a51685b-4b13-445d-8baf-7d24f937da7b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4db1700d-f21c-4238-92e6-ba985d710969",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ff4328c-6b90-41e5-a1aa-aee996ae1750",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-05T07:28:15.8433285+00:00",
"id2": 60
},
"db_language_id": "cc739653-7832-4aa6-a97f-30f43530f2b0",
"db_language_code": "sample string 7",
"db_title_id": "f4f0ac96-be56-4ee9-bc96-aaf23bee7b35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-05T07:28:15.8433285+00:00",
"create_date": "2026-09-05T07:28:15.8433285+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-05T07:28:15.8433285+00:00"
},
"modified_dateutc": "2026-09-05T07:28:15.8433285+00:00",
"id2": 22
}