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": "ab68cfc3-930e-4c1e-9834-6a08edd414a2",
"_parent_id": "df858e6b-f890-4d12-9597-04fe92666653",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2d7c21e3-dd00-4ba8-a817-2541bbefc6e5",
"company_id": "7e50fc9e-5f60-4b78-a97d-4c04f1beff41",
"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": "090f66a6-e0ca-4166-a29b-306f0a4a7f6a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c4510a32-1430-4606-bffc-9c68ace5aff0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3fc0b101-e3ce-4345-8832-f42a95ed930b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0ad427bd-2e7a-4d4b-ad94-46e85e8769da",
"company_code": "sample string 5",
"company": {
"id": "39877a5c-10f8-42ca-815d-58ba5d293636",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T14:46:24.0155496+00:00",
"sales_territory_id": "6cd808e7-576d-4bde-9af7-0f765cedb55b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4669167e-d306-4b1b-a4c3-deceface2260",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e6ae38bb-f19a-4b6a-b2f1-f6bffaaeda18",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bcc84190-770e-41db-ac3c-4e031507f968",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9fdaf692-7c30-46ce-a9f1-2820711a1cbe",
"db_currency_id": "fb5366bc-16b0-4418-8f40-37029ffa9680",
"db_language_id": "fbf19082-a970-4905-80a0-cce6beba047a",
"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-19T14:46:24.0155496+00:00"
},
"modified_dateutc": "2026-01-19T14:46:24.0155496+00:00"
},
"marketing_segment_id": "c98474ad-8f11-4b1d-b28f-6a43cd68b49c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d63952d-aa5b-4c99-b03a-73bfcaffedfd",
"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": "d301142e-04df-4f47-a142-c87a8140fda4",
"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": "1a11b7b5-216b-49fd-96d0-5e3144ccf1fa",
"db_country_code": "sample string 28",
"feelist_id": "5329cd2e-d8a4-406c-853a-54164e61c118",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18baefff-8c94-4124-afbe-9209be0e2ad6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98f356f0-2c99-4871-a015-3dc2c19a45dc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T14:46:24.0155496+00:00",
"db_currency_id": "0534cc34-c984-470f-aec2-1eb4f56448c4",
"db_currency_code": "sample string 10"
},
"company_type_id": "2766eca9-117a-4bce-bfa6-04db08ed462b",
"company_type_name": "sample string 32",
"company_type": {
"id": "85d5e1ff-6991-4ec5-bfa1-d224d29a1ef6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af89b274-99c8-4c4a-a50f-4028d3207e4f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "49e62613-eb41-4dad-9ca3-d06234281a41",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f8573ca9-598f-496f-b2b0-5ae25ce52deb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "accb99e4-59a8-4d5b-b1cd-198c45bf71d6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "283d191f-0bcc-40e4-9a4b-e547fd044b7f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T14:46:24.0155496+00:00"
},
"company_sector_id": "828a7fc7-5b09-4245-bc68-bf2cb1e5ab8d",
"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": "dbda6626-220d-4508-bc91-8a36ba086391",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "06e8ca65-a17a-4403-87a6-e7a5512075e9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "11a1b848-d103-48e2-b6a4-637a65ff8e3a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c9735ebf-0958-443e-a46b-8210f616b3fa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T14:46:24.0155496+00:00",
"id2": 60
},
"db_language_id": "385d279f-700c-421c-ab06-4b5a5dc8662b",
"db_language_code": "sample string 7",
"db_title_id": "b31457f3-655a-4fec-aaf3-82ce9f18fa0e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T14:46:24.0155496+00:00",
"create_date": "2026-01-19T14:46:24.0155496+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-19T14:46:24.0155496+00:00"
},
"modified_dateutc": "2026-01-19T14:46:24.0155496+00:00",
"id2": 22
}