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": "9f13084e-c717-4ce4-8f5e-0a00cf2fa7de",
"_parent_id": "3de3f710-cced-4849-96b1-093ddf593a59",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5ae24461-801e-43a0-9228-1336149eb519",
"company_id": "42cc3ee2-a77d-4590-b7a3-3e54a2dd9ee5",
"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": "1d408c54-4375-4e19-8ac8-2ebbc73e5f04",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5f86a6bb-6319-4b71-8ca0-d2c6756a7eca",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "54ea9a1e-7696-42a0-be22-d4410b7e0d55",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "484b28de-7e3d-470a-bf2b-fa0577e7549b",
"company_code": "sample string 5",
"company": {
"id": "187fb80c-eec5-447d-a49a-cc0c50e8476a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T03:50:36.718863+00:00",
"sales_territory_id": "171a013c-b26f-49f0-a944-42d5418c42c5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41fd09a8-f28e-4ef5-92bd-3ebd05f7bdce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9a0904a-4ef2-45a4-ad30-7cfd4897bda5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "661e2222-638b-4466-b444-0440718a8075",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "567d4fa3-c23d-44ca-99ca-21c1932204ed",
"db_currency_id": "f5c6e422-76cc-4cf4-87d8-f717ec9a0814",
"db_language_id": "21114e2c-9c07-46fb-a199-f2914077a3a8",
"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-02-25T03:50:36.718863+00:00"
},
"modified_dateutc": "2026-02-25T03:50:36.718863+00:00"
},
"marketing_segment_id": "02daa2ad-9bde-4ad6-b29b-84265adf56c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b659edb5-e7c2-4300-8056-2f1fcf064de5",
"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": "ec97ef38-2ba1-48cb-a94a-57071dae70c4",
"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": "21c7b9df-4127-441d-b4b7-a6ba2e9b7dd6",
"db_country_code": "sample string 28",
"feelist_id": "321b1153-eadc-4da4-b8d4-a1062818aa9f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ceb4ffb4-68c9-4b3a-b6a8-15edd549ccac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1fd8a7b8-2787-4ab0-a899-d320a99d2d69",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T03:50:36.718863+00:00",
"db_currency_id": "19758360-f44e-4cd2-8e81-03deca71f262",
"db_currency_code": "sample string 10"
},
"company_type_id": "78e2da79-4288-4ff5-ad96-4112c9f17134",
"company_type_name": "sample string 32",
"company_type": {
"id": "8e80c928-4541-4083-8a9c-6dda82934063",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de570b9a-17af-412c-9039-38a1514b0b07",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f7ac704b-dd7f-4291-8c1c-dd9accc08297",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1a1b7028-f9e6-4157-aa0c-d37f6d3f1640",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "592c8d4a-79f2-48fa-9615-d5eac7528201",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5db46522-f940-4f7c-b299-efb1261e0690",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T03:50:36.718863+00:00"
},
"company_sector_id": "2f674b5a-a383-4d46-849f-d5b904d9227d",
"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": "56c07060-4450-4f9d-bfd4-ebecdad282f8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcb53e0c-a3dd-4169-ac91-7d12ac2a5849",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "78551a94-2da2-4254-8aa1-d1fba37c399f",
"account_manager_user_code": "sample string 56",
"company_status_id": "a72ea2cb-2685-4ce8-9765-86879d9e19a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T03:50:36.718863+00:00",
"id2": 60
},
"db_language_id": "188dd654-db0e-43a6-9cc5-d408cd02ef73",
"db_language_code": "sample string 7",
"db_title_id": "f9dca93c-4a44-4ea7-a06d-93bdf0efd9a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T03:50:36.7344861+00:00",
"create_date": "2026-02-25T03:50:36.7344861+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-02-25T03:50:36.7344861+00:00"
},
"modified_dateutc": "2026-02-25T03:50:36.7344861+00:00",
"id2": 22
}