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": "ba1df260-3e86-4849-97bb-641923151459",
"_parent_id": "5f4211e3-5380-4f77-be26-480bb91dbbf2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f41816e3-f3a6-4aec-8407-a00d9269ac05",
"company_id": "ca807465-3c34-4372-b23b-51338d3c2d2d",
"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": "d1126ea2-ac12-4e00-b655-fa3d9989eaac",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "fdd1bdd9-0ee2-4643-adc8-4291a07b8830",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "15d95368-4aaa-45bf-a33e-798604c775a0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7a705c9b-6267-4169-9ff8-719cb057563e",
"company_code": "sample string 5",
"company": {
"id": "d2c36e15-1b24-460f-834a-6ed4441683d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-12T07:29:28.9830301+00:00",
"sales_territory_id": "072bc2b7-4ae8-4832-8c92-d012c6282197",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7bc192c-b2a3-4d5d-b8e4-12e4236bfc01",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3738aeec-a737-4bdc-acaa-a80f13855537",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c75386bc-3961-40ec-8dd3-5fe0c72370bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3da653f1-f6f4-43a8-b298-df3b4b3e23aa",
"db_currency_id": "1b792de9-93cb-43de-bc2f-f7317159f5e9",
"db_language_id": "350a2964-d73d-4d94-aed7-27aaadd0d660",
"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-11-12T07:29:28.9830301+00:00"
},
"modified_dateutc": "2025-11-12T07:29:28.9830301+00:00"
},
"marketing_segment_id": "777943c2-f22a-4159-8b37-0f416a6c8b6e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bac8688a-d9ff-4e5f-b69d-a0cb49237f2b",
"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": "eb535cdc-3178-4ccd-814c-279947b60c98",
"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": "3c704cc8-f44b-47ff-a035-7542412c2211",
"db_country_code": "sample string 28",
"feelist_id": "42330311-2a66-4b80-8dd9-d76717a7df17",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "512d62e8-2caa-4811-97ef-94476b338e79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "96be90a7-e595-4917-b608-0ddddd724d93",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-12T07:29:28.9830301+00:00",
"db_currency_id": "19dfd24f-5dd5-4624-b471-c3822e99bbdc",
"db_currency_code": "sample string 10"
},
"company_type_id": "5d190945-1128-407f-9abd-4f9ec8a067a2",
"company_type_name": "sample string 32",
"company_type": {
"id": "688a45f5-9a6f-4a46-a440-3b6e0dd712fb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad252584-5718-40ea-ac9d-80f27d6ce967",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5bfad8ea-2849-4e94-a4fc-3948c3c79297",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "72e5ec73-9be2-4387-949f-6be63e1795c8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b170951a-6971-40ce-95b9-fada650bd080",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9d5c9695-8ef6-4c24-80f1-babc3b18a750",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-12T07:29:28.9830301+00:00"
},
"company_sector_id": "9e8b14a5-b5b7-4c46-b06d-90ad47909a0e",
"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": "1efbb295-e57e-4e68-a5b0-955a2ab27869",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6d443199-97b7-4c0d-9389-afc5e1b23cb3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e5261e2-4253-472f-9725-1ab979bfb9a9",
"account_manager_user_code": "sample string 56",
"company_status_id": "67c6a65b-4faf-4ae9-bdfa-b37a4c14c0c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-12T07:29:28.9830301+00:00",
"id2": 60
},
"db_language_id": "515d5bdd-deba-44a4-87e9-d79817551029",
"db_language_code": "sample string 7",
"db_title_id": "2beb745b-e62d-4283-9b44-c3b36c07361c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-12T07:29:28.9830301+00:00",
"create_date": "2025-11-12T07:29:28.9830301+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-11-12T07:29:28.9830301+00:00"
},
"modified_dateutc": "2025-11-12T07:29:28.9830301+00:00",
"id2": 22
}