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": "a9b2875e-3f4e-447b-8a05-4a544ec14210",
"_parent_id": "bfcf38ee-1901-43f5-9e1f-3959ff3bbed8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2b215cd5-ae92-45f5-91f7-6ba53fd50abf",
"company_id": "36aa7008-1102-4701-9d69-4dd3be083da5",
"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": "09fae0b9-8910-4bca-aa82-999268a0ace2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "179b7c85-900d-49c3-8b19-d60ed76bda4e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "636f6344-fb81-4d15-a04a-52bdab374e61",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "24081acf-c969-4508-8f23-b056462a4486",
"company_code": "sample string 5",
"company": {
"id": "56669f83-46da-4f34-bdb8-342f7ff9bb39",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-28T11:05:32.2746795+00:00",
"sales_territory_id": "9fa0e2d8-51de-4921-aea3-fd5928a204bb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2d9effff-79d4-489d-bc36-e31a67b59747",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "741dc481-2022-4226-8d64-280f1ccd8e68",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0a3a47c6-f220-40b9-8608-89f298cde2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "535030a4-c16b-449f-bd34-00e9173f4bfc",
"db_currency_id": "c4ee6c68-b229-4242-a091-dc626b5d9d01",
"db_language_id": "10c223e9-9f9a-4e09-b33b-5e2f8971a24d",
"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-28T11:05:32.2746795+00:00"
},
"modified_dateutc": "2026-09-28T11:05:32.2746795+00:00"
},
"marketing_segment_id": "aad7ebae-6001-48d5-873d-c8db18dc4208",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "403e3da2-0d52-4dea-ada2-6788bc2ee3e2",
"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": "b293c9fd-1d5f-437f-8485-6130cff766e6",
"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": "0506ec94-c95a-4ca8-8908-b4775fc0f3ff",
"db_country_code": "sample string 28",
"feelist_id": "74db4070-9630-4f0b-a6ee-478361c97c46",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "482f1d24-be14-4c9e-8f37-155ee6f7d62d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c7ba0c64-dc4c-4524-86cd-01d504405b2f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-28T11:05:32.2746795+00:00",
"db_currency_id": "6c58d69c-7157-4164-a191-c8a21ece72ca",
"db_currency_code": "sample string 10"
},
"company_type_id": "cb074d79-fdd2-435e-9dfc-aac41bf57c5e",
"company_type_name": "sample string 32",
"company_type": {
"id": "91cd4eaa-6500-402d-86cb-24d94513b378",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8831a9b-c296-4d18-8812-031d46d68dec",
"sales_organization_code": "sample string 5"
},
"db_language_id": "57703176-a7c5-41b7-9086-f39342fb47df",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c539feb-74d7-458a-a40d-3b659c5f10ff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b7e7e2e-e19a-4ea4-b38e-199b9aea6454",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8a232451-14d0-430f-badf-15f59f908c77",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-28T11:05:32.2746795+00:00"
},
"company_sector_id": "f4233f58-8655-4dc3-b223-2a181e8900b3",
"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": "aefa52e2-b95b-4a73-b84b-dc30d98d406c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dd2f0cfa-61cc-4845-9f8e-0064bf6e2d70",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "01a7f085-d65b-463d-8e56-2b60570ac4f8",
"account_manager_user_code": "sample string 56",
"company_status_id": "29d17f08-aec0-4fc9-b932-1215b3c5d299",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-28T11:05:32.2746795+00:00",
"id2": 60
},
"db_language_id": "a3814c3d-45a8-4a0f-a8cd-63afa379b00c",
"db_language_code": "sample string 7",
"db_title_id": "6ae37028-73b5-4273-b4e2-3895883503c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-28T11:05:32.2746795+00:00",
"create_date": "2026-09-28T11:05:32.2746795+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-28T11:05:32.2746795+00:00"
},
"modified_dateutc": "2026-09-28T11:05:32.2746795+00:00",
"id2": 22
}