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": "236c2f36-2701-4595-adc8-06ee24dedf9a",
"_parent_id": "b307c7e4-802b-457e-80c4-df636920e2d0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b2454017-fb38-4cee-9635-566c1a21ad23",
"company_id": "19ee9d08-c608-4c0a-8bda-2790d4180d5f",
"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": "2f441dbe-f060-4317-85a1-c29bf8631684",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "36f7be46-bd44-4313-8ccf-5d5980381c8a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b519d082-8de2-4177-b55a-ab77b005c284",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1490dcf7-cdf5-4529-b0ff-fd0bffacdf74",
"company_code": "sample string 5",
"company": {
"id": "db663f19-7d9d-4afb-bed2-f97152c27eac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-05T05:18:58.1045526+00:00",
"sales_territory_id": "737a1b34-d258-4252-b151-2d1d1f5a4875",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "860ff39b-3e8f-4b01-ac61-f0df28907fa0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c13adde-0efe-4ec6-b253-94c06f712d59",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "53a020ac-6b77-4d2c-82eb-a22dc5dfeffb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "544729f9-ca11-43da-bfff-939b77a8bd12",
"db_currency_id": "07624716-4c53-43d3-b304-9b4ecf314b71",
"db_language_id": "2a198e6a-4043-4b2e-99c7-e94688b9ea4b",
"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-10-05T05:18:58.1045526+00:00"
},
"modified_dateutc": "2025-10-05T05:18:58.1045526+00:00"
},
"marketing_segment_id": "a51d6305-0489-4480-9704-89bdf90f7424",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c522640-ebb5-48e1-95cc-3c1c8ce4e4fe",
"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": "4bbd1e10-2bd9-4579-8461-a229d6af572a",
"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": "80833ee0-8841-4588-84b1-2df3e57fb2dd",
"db_country_code": "sample string 28",
"feelist_id": "232ab1db-9fc2-4443-9055-f7553545c16a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "459a1596-f86b-4e1d-9234-4d56ee823775",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d23daf4-3071-41c7-9ae7-e89f119f11a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-05T05:18:58.1201739+00:00",
"db_currency_id": "6fa9ec8e-e463-4bed-85b0-f8dce7a6cf47",
"db_currency_code": "sample string 10"
},
"company_type_id": "33a05ab0-d926-48ee-a577-ac2f674cf400",
"company_type_name": "sample string 32",
"company_type": {
"id": "a661ec4f-7ad0-493c-8f9c-840becb2b7bc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8f77defa-2f5f-4774-bac7-6b4ded79b49b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4935fa4d-d014-40c2-8aa1-90d14ab737c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8acd53d5-e0aa-4fa0-b4b0-b00c94164a3e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9e1f442b-d3f5-48ea-878a-7780c5cf22dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "02dccdc4-ef5d-46e2-98e6-6d89287893d2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-05T05:18:58.1201739+00:00"
},
"company_sector_id": "25385c4d-b269-45ae-abde-a387f0718cb3",
"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": "dced050e-101c-49d0-8ce4-548d00ccf62e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4ef5789a-3c77-4192-bc20-b749b17c43f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e68643a5-f1c2-4dff-96fd-dc752a9bf1c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "d65bd6d9-fef8-4bdb-84ac-343692572015",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-05T05:18:58.1201739+00:00",
"id2": 60
},
"db_language_id": "686e777d-69b1-41ac-a7c4-1d5cc29d5189",
"db_language_code": "sample string 7",
"db_title_id": "738875a6-173d-4043-8736-48e2cb76cae6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-05T05:18:58.1201739+00:00",
"create_date": "2025-10-05T05:18:58.1201739+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-10-05T05:18:58.1201739+00:00"
},
"modified_dateutc": "2025-10-05T05:18:58.1201739+00:00",
"id2": 22
}