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": "82c87a3d-86eb-4648-8443-5f68b68ed210",
"_parent_id": "f7d95ed8-17f2-404b-833f-3872b7d298b1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "741c6d29-3c12-4789-8d3e-1139f79038c0",
"company_id": "eb125dc1-d82e-416a-849e-6a1108acbb50",
"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": "e9573614-b2c8-4882-af98-56eac851241f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "39e29524-97aa-4786-aee1-62daef70e455",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "00ecd512-f3c2-4679-8593-e1e6213a39e7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5fe134f7-2455-4b62-9b1c-b74738037e00",
"company_code": "sample string 5",
"company": {
"id": "052c0c0a-e631-4d78-b750-7478aab35fcd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:51:34.0787415+00:00",
"sales_territory_id": "39743c3f-f7e3-4c38-b4cc-121492432d4b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5dd462c1-adc7-48c3-8b4a-20063ae219c1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e0d5be4-1504-4ccf-8cc7-b1e9b1f1a7bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bcf8d836-2d7b-4e04-bff6-f4b7dfe7be05",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf57d57b-28bf-4f9e-b2ca-0f308fc2a87d",
"db_currency_id": "9ce43902-d8c0-4afc-ad09-8243a9cdf2ca",
"db_language_id": "0d651ed0-6b6e-4f63-a546-fb7fa15056f5",
"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-06-21T11:51:34.0787415+00:00"
},
"modified_dateutc": "2025-06-21T11:51:34.0787415+00:00"
},
"marketing_segment_id": "b1313f6b-1ff0-452c-b18a-ff31ac426052",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57926801-cc20-4897-b7e9-ff5b4fc2b7d9",
"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": "b1d6f445-1820-4b09-8d0f-e9d39e886048",
"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": "f45cc126-67ae-4839-a28d-9772917da1b8",
"db_country_code": "sample string 28",
"feelist_id": "aea822b6-35c6-442b-a78d-f765181d9ffb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bb238b96-9691-4546-ba93-9100068da19a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d9034e6d-5aba-49ac-9f38-694ab422b0b6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:51:34.0787415+00:00",
"db_currency_id": "ca83dc6b-8254-42c8-9304-77df3cb2860b",
"db_currency_code": "sample string 10"
},
"company_type_id": "2468263e-8bed-4f95-b7dc-aa174ee73bcc",
"company_type_name": "sample string 32",
"company_type": {
"id": "f6a91a19-a850-41f8-9e46-2dec2e3aa799",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad847071-f16c-45f2-9504-4a6b615dc649",
"sales_organization_code": "sample string 5"
},
"db_language_id": "223713ed-39c6-44c9-86a4-f24e03c61880",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7ce841e4-062f-4536-b5fb-3e083d823e89",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "455d6f17-8de2-4fee-a899-26881048550b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5c3aa36d-ae2f-4ec4-a78b-46b05a75d34f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:51:34.0787415+00:00"
},
"company_sector_id": "055c34cd-cfeb-45c0-8064-a808cce1bf29",
"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": "6a863326-9016-4617-adcd-d4b7cbd10b55",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "de53a198-6b51-4196-8b87-c1e30935d1f6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "771d4f46-8dc4-4de3-b48f-434befc500f7",
"account_manager_user_code": "sample string 56",
"company_status_id": "9a07c650-ec10-4bde-9a33-b3292ba5aab8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:51:34.0787415+00:00",
"id2": 60
},
"db_language_id": "84a1a6c2-a8b8-4bfa-b05d-14675cf2f263",
"db_language_code": "sample string 7",
"db_title_id": "2279a739-5662-43df-82b4-4d8bcf86f702",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:51:34.0787415+00:00",
"create_date": "2025-06-21T11:51:34.0787415+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-06-21T11:51:34.0787415+00:00"
},
"modified_dateutc": "2025-06-21T11:51:34.0787415+00:00",
"id2": 22
}