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": "58a89cdf-8cab-4dcc-91a4-fd07df6b9451",
"_parent_id": "bae1a341-4aec-4882-8e95-92a0d349fec4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0b26900f-bb64-4089-898f-afd7cc4dc3aa",
"company_id": "285a2b91-3cb3-42d0-8459-316216aa81e4",
"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": "133993ee-0377-4fc2-8be9-06a1a1071d2e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c6ee513d-cd76-44db-abd7-a0294163b1ac",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f445ba9e-04bc-4536-b402-cbe4459c01a4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "08cace57-5ac0-4eb9-802b-1d096bc244e2",
"company_code": "sample string 5",
"company": {
"id": "0133a411-3d88-421f-b77f-468bd04f21c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T17:11:54.9974222+00:00",
"sales_territory_id": "b6c235c9-f68e-4402-b506-f93e067b1edc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "90070f16-5ad8-4e9b-834c-088f33ad7ed9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd8c88b6-4c50-4cfe-9170-f2fdcc763c1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7a92dff-7789-4326-b66e-5e42902765ec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "871f38d8-1d09-440e-ab48-73eabf07e3f7",
"db_currency_id": "fede0fc4-8faa-4a4a-a39a-dc9b47cbe9a6",
"db_language_id": "86b0441a-a06d-44ec-90e8-61cba5f94e96",
"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-05-23T17:11:54.9974222+00:00"
},
"modified_dateutc": "2026-05-23T17:11:54.9974222+00:00"
},
"marketing_segment_id": "98f9b815-59b8-4dde-9bd1-59189e3ab0d5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aa6b558e-3983-4f7c-b6fb-06380cb3fe7e",
"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": "04e38a4e-471a-4245-8d11-447924937bd6",
"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": "29785f53-d950-44db-808d-e60ddca4f67a",
"db_country_code": "sample string 28",
"feelist_id": "f39e287c-99c5-4b42-bef5-8e338fef8d59",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c4c76b3c-79c6-4598-9533-3706b8919e6c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ebf1b0ba-460c-410d-80e4-6dcd784a5e37",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T17:11:54.9974222+00:00",
"db_currency_id": "5cdd8d49-4c25-4dbf-8c8b-73de5d41e2bb",
"db_currency_code": "sample string 10"
},
"company_type_id": "727ecbea-64b9-4ec4-b318-58deb164c60c",
"company_type_name": "sample string 32",
"company_type": {
"id": "b459b9e2-2a71-44b7-bd3e-4d9e4c0a2499",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46b24fd7-b1f8-4b25-b331-6789d026cca3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae1e405e-c53d-4438-8c0f-478d81ee21ec",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "26f1eb76-1127-4c54-bd2f-5d2481ac3d28",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b375b5ac-f992-446b-bd96-bde256c6c40e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "87c1f3ea-3bad-4796-bb86-c59d32502b83",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T17:11:54.9974222+00:00"
},
"company_sector_id": "23ece3ab-84b4-42d9-bab2-a964ea9e5e33",
"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": "6646746a-189b-402c-b1ab-1c5d94ed69fd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "56ea3b79-75f2-4d72-af1e-06f379dc83e7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d622b2c6-87ad-4418-b6a3-cb8bf756e534",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ca3802c-039e-40ec-bc31-45353e8c491b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T17:11:54.9974222+00:00",
"id2": 60
},
"db_language_id": "f3e63740-f5e8-4c1a-81c7-17d356202356",
"db_language_code": "sample string 7",
"db_title_id": "e59a26b1-7d75-473b-b6aa-3df0f355621e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T17:11:54.9974222+00:00",
"create_date": "2026-05-23T17:11:54.9974222+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-05-23T17:11:54.9974222+00:00"
},
"modified_dateutc": "2026-05-23T17:11:54.9974222+00:00",
"id2": 22
}