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": "2ff888fc-e92b-4710-8587-86c7a58f6d58",
"_parent_id": "4cbf6784-f498-43dd-825e-d575935a483d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "dd912d76-60f3-4bd7-a38a-94d1005a9b17",
"company_id": "60e9fc35-aa37-4c92-8dea-1a5b2cb0adc9",
"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": "03af5e32-d784-4be2-ab34-a82407c4d467",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "09278bc6-6466-498e-a9ed-5b27769f434a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a32df084-dbee-4176-9eb1-56c999fd09b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c3e6460b-c57c-4132-9891-0bf6e60ae8c6",
"company_code": "sample string 5",
"company": {
"id": "7d2246c9-0be1-4df1-b378-61cc71a9660d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-13T20:54:19.7124181+00:00",
"sales_territory_id": "fa0baca7-1039-4d68-9202-f62f78127bf6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d92c11fa-f000-487e-85bb-67dd2a79c886",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fa2071b-0224-42dd-8bd7-99d9cbc5678e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2c93ad6-2d89-49a4-87d8-1863eba25b0b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7b91d9d-168b-4e76-819d-88471961b4da",
"db_currency_id": "93db3c83-adec-4ed3-81cb-b20c0b48d1f6",
"db_language_id": "eb9f92ab-f307-41f8-a014-5637aef9889e",
"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-07-13T20:54:19.7124181+00:00"
},
"modified_dateutc": "2026-07-13T20:54:19.7124181+00:00"
},
"marketing_segment_id": "f881f378-6579-4017-b9c0-6cd827a3c59f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "47a752cc-bf9f-4cfc-8279-a6a625144a18",
"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": "6be1f595-1e68-4160-a625-6cf82248fb35",
"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": "7e3e2b35-8e6d-43f3-b297-22530b9bead9",
"db_country_code": "sample string 28",
"feelist_id": "3043c09a-e88c-4c4a-824a-5aa88fc2c8f7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "281fe456-a3e9-464c-a47b-d96a4291f29c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fdf68faa-184b-4216-a4f3-6c23722e8754",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-13T20:54:19.7124181+00:00",
"db_currency_id": "723a57ff-ef71-4982-b783-a00e5f4b00ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "7610614b-a422-441e-9975-ee13508690cd",
"company_type_name": "sample string 32",
"company_type": {
"id": "a7b4b919-e725-4746-9d86-3c6991a69734",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "933f734b-fb97-464e-883c-e4b55c858cc1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c76b3dc2-b87a-46cb-a4df-8c11bc7ab0d4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d1ab4a45-bdc7-48cd-ac16-4286c5ae4f98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "51f357f0-0687-4fdd-bbda-1f165cc5c53c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "050fbee3-8655-4d9f-bbc8-c5cb032c56e8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-13T20:54:19.7124181+00:00"
},
"company_sector_id": "7b53e319-ddc1-422e-b356-c9a474574c53",
"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": "e2640ab3-4b48-4d20-a46b-f1aa37ba92ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dca3b2ee-41aa-432a-8c7a-f56eaaebabe7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "edf410c1-e0dc-47fb-aafb-fe0297c301ef",
"account_manager_user_code": "sample string 56",
"company_status_id": "1c07d8cb-49e1-4d7c-9d92-080c921b363b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-13T20:54:19.7124181+00:00",
"id2": 60
},
"db_language_id": "40ed3317-9572-4d2f-8dd4-6918c22add7f",
"db_language_code": "sample string 7",
"db_title_id": "a1104904-de92-4843-b487-28842edd078f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-13T20:54:19.7124181+00:00",
"create_date": "2026-07-13T20:54:19.7124181+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-07-13T20:54:19.7124181+00:00"
},
"modified_dateutc": "2026-07-13T20:54:19.7124181+00:00",
"id2": 22
}