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": "ad52ccbd-f2ac-4932-aac5-95028a5aa19f",
"_parent_id": "fe290bcd-5db6-4d09-bcb3-b1fdbbd07c75",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1569a2b7-60c7-451a-aabe-cacc0c134dc9",
"company_id": "2e20633b-5f81-4c3f-81ac-23ba551a3401",
"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": "398711f1-2513-40e1-b4b6-4fb151eefed2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "826685e5-4899-4ad7-ac29-22e8adca1d80",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3dc4772c-58ad-4d51-bf21-4960cde925e4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e0a636c5-d771-498a-8ed0-921e1f9685e2",
"company_code": "sample string 5",
"company": {
"id": "263697ea-3044-4fb3-8c4c-e07b87029cc3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-12T14:11:10.8985694+00:00",
"sales_territory_id": "e0be71d4-383f-4ebb-9b7b-4eba8a4d0c59",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3cf0c373-221e-4160-9c72-11d70ba54355",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be4dfc9f-c22b-4ef8-a0fb-7b7e116d4cdc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9dfdeefb-46e4-46fc-85e6-4a64a7e94b1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33d7cc40-85d8-4609-af19-437342c831a6",
"db_currency_id": "218eeb5b-d2b6-4654-8340-6a1177b5437b",
"db_language_id": "c9e7d43f-b858-49ef-b864-e4428cfc52be",
"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-01-12T14:11:10.8985694+00:00"
},
"modified_dateutc": "2026-01-12T14:11:10.8985694+00:00"
},
"marketing_segment_id": "90a67918-b994-484f-8bb0-8b0099275f38",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7168b403-7977-4efe-977c-29a56f3dc4c7",
"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": "b95438d0-158c-4ded-91eb-8ca9821cca81",
"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": "4e8764fa-5004-4ff1-a1da-c050fd15dd90",
"db_country_code": "sample string 28",
"feelist_id": "54eeaceb-4a5c-44e4-a34d-df17213e11cd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "02d93556-9c2d-458e-9fa5-81c0320a3cb9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "786425fe-4d88-4e33-9ac9-caf0ce9670f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-12T14:11:10.8985694+00:00",
"db_currency_id": "cbf6f455-10e9-42d9-985d-0f5bc1e97af9",
"db_currency_code": "sample string 10"
},
"company_type_id": "2a811b6d-d0c6-4d6e-8783-369ec2d742a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "d2361a7f-de34-4bba-a0fa-cbb865d74cc9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5515ba10-b7e3-4ed5-a485-9761f749376f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6452b587-218e-4202-8532-a8303d5c1342",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "336ee899-4ef4-42cf-a3f5-a933100d46de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5899b67a-246e-495f-b49a-208b7659980f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "391ec980-d10c-4799-9586-c3e027760a47",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-12T14:11:10.8985694+00:00"
},
"company_sector_id": "c697f5a3-d85e-4f98-b670-5573984948b4",
"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": "4a60f204-b80d-424a-99b6-1eae5e3387e2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ec5d6e20-f192-404a-adb3-c57c3436f96e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "043ad323-6304-4460-82e4-ca365da25505",
"account_manager_user_code": "sample string 56",
"company_status_id": "72f112d9-29c4-4785-a69d-a5528e1d0e64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-12T14:11:10.8985694+00:00",
"id2": 60
},
"db_language_id": "5fc53569-d70e-4c41-8e89-43e516953422",
"db_language_code": "sample string 7",
"db_title_id": "fd3a4ed9-e16f-4c93-84cd-3e1e015333ec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-12T14:11:10.8985694+00:00",
"create_date": "2026-01-12T14:11:10.8985694+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-01-12T14:11:10.8985694+00:00"
},
"modified_dateutc": "2026-01-12T14:11:10.8985694+00:00",
"id2": 22
}