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": "b6631070-6c1b-4b0c-a2c3-d42bbc1ebe35",
"_parent_id": "46ab3184-8fd1-44d1-8d62-b49ce7c94df1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1a5aea07-bfeb-4ec3-ba42-4f9f382934fb",
"company_id": "d6e96eb7-3e78-4416-a85c-995c3b0d57b0",
"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": "09ec4e9f-df8f-4b57-b188-edb1c392bc52",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "27a4cb43-3dda-4d18-a823-3d72092ba018",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "22d8f153-d4c0-438a-9afd-39cf14956f47",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05c131af-6501-49ec-9805-265b33835349",
"company_code": "sample string 5",
"company": {
"id": "072e212b-7a9b-4578-a231-28c08d270e6e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-14T06:27:57.420668+00:00",
"sales_territory_id": "e3f8f946-48a8-4490-9e75-9545e4732c1d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6e63e26e-ff24-4ccf-9709-36c01fa66f6f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82221acf-91bb-4870-8a3c-c775412eaaec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06ddf6a7-9b5b-49d4-9c86-402e2f14c423",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "367e6969-f1d0-41c8-b327-bfc6b3f79fd2",
"db_currency_id": "6f48ee43-15b0-47d5-bc73-6b4909505e84",
"db_language_id": "8fd7d781-4e1d-4388-baf9-1fd7b58a4383",
"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-14T06:27:57.420668+00:00"
},
"modified_dateutc": "2026-02-14T06:27:57.420668+00:00"
},
"marketing_segment_id": "20134d30-baef-40b7-abba-db65b9b5e30c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b5fdd323-56bd-45d6-8be8-a02d001964ed",
"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": "cdecf769-fbf1-421d-96a4-849090b97b0a",
"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": "87f8cb36-e205-4828-b57e-0d9f44049458",
"db_country_code": "sample string 28",
"feelist_id": "30346317-df03-4239-badc-ae782f55c979",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b2fcd12b-f773-49d7-adc6-86686ffaf551",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09c82364-11f9-4d1e-8c55-6574c4acf36a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-14T06:27:57.420668+00:00",
"db_currency_id": "8a144c45-04b1-4d6b-a12b-f5ec0511bb9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "d7a8c21c-7e1c-4c94-88f8-6a9f48140b24",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7ec9ab1-2cc2-4a36-8aca-74790629bfd3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27d6b5d9-5a80-4e4a-a1aa-5f6925fab19a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b3ad574-e800-47c5-83a8-1c89d93f28fb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d54b1caa-bf43-4257-9785-c2aa8b8f7282",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "27696ea3-2e47-411f-89d2-f56e10af0268",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "059ed3d3-8da1-4a29-9af1-94b3e904882a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-14T06:27:57.420668+00:00"
},
"company_sector_id": "cf8d1ce5-ff15-4db5-8c2d-f3028c391f86",
"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": "abad6b21-898f-4ed2-b153-1494ebe626f4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "90ab9be2-e59b-4aff-ac3f-aefe70dfe711",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f3ae7fd0-4b91-447f-ac05-8421579bd152",
"account_manager_user_code": "sample string 56",
"company_status_id": "9e2ff064-dd69-40fa-8c9a-9fb2ce88f793",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-14T06:27:57.420668+00:00",
"id2": 60
},
"db_language_id": "70c55baf-f848-4c72-9b61-c504a1212cb6",
"db_language_code": "sample string 7",
"db_title_id": "3340fb27-340d-4159-a9d0-79af1e9f9539",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-14T06:27:57.420668+00:00",
"create_date": "2026-02-14T06:27:57.420668+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-14T06:27:57.420668+00:00"
},
"modified_dateutc": "2026-02-14T06:27:57.420668+00:00",
"id2": 22
}