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": "50ba905d-4efc-4e35-b357-6c1a9b51048c",
"_parent_id": "2340753f-971a-459f-beb1-ac0f5f299b68",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "06410f39-a16e-4a49-a155-6ab7dc7460dd",
"company_id": "1d8b3405-071f-4d34-9ada-35ceb50360ea",
"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": "abb382d6-d535-414b-961e-bb4d83f240d0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "514b6ab0-1d76-48ba-9d99-6f596481d7cf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a545f1a4-9339-409e-b366-14502effd874",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "855cf6c5-f2fa-4db3-b76d-abb9c11ed9a7",
"company_code": "sample string 5",
"company": {
"id": "3446d93c-1eb0-427b-9a02-4aa91e844aa8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-26T11:35:32.5664134+00:00",
"sales_territory_id": "2a7cbfad-1faa-4025-9b9a-d2f6c5ae3dd8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7cddd654-918f-407d-9f51-fea54cf3a397",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0b4e1f7-1a2b-4181-8b24-fc4319c8e74d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "477e0785-e6cb-4025-b959-f8f45dc01897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04cf509-7f5e-4179-823a-9cdf94519ed1",
"db_currency_id": "294ff9eb-fcaf-43a1-8189-d1c74e9de0bf",
"db_language_id": "96a6aaae-04ce-4c46-a2e0-5d742b913f35",
"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-10-26T11:35:32.5664134+00:00"
},
"modified_dateutc": "2025-10-26T11:35:32.5664134+00:00"
},
"marketing_segment_id": "e1bf7dde-926a-4352-9ca7-672d1e3055b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ca746d98-719c-4a2f-93af-6beed04a2971",
"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": "4542c470-be08-4f2f-8753-e779597f1574",
"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": "d84184cd-aec4-4ec3-b1f5-aacb2292de87",
"db_country_code": "sample string 28",
"feelist_id": "daa827d6-012a-4de9-9a5d-cc6d59afaf1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "50b87172-0809-44ed-a8c8-b4946e726c3b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "307b2710-0b49-43ad-8d72-9686f519c357",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-26T11:35:32.5664134+00:00",
"db_currency_id": "85ba10f7-687c-4e15-9e9e-eea18ded8251",
"db_currency_code": "sample string 10"
},
"company_type_id": "6f2ab47e-c66a-4f5f-9a49-d17a7fcff1ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "76c4dec9-3bed-4875-a2da-cec04373b26b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1ed095b8-e4a6-4534-b723-9a4f5ca75468",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7b7396ad-0fdd-4e85-ba1e-bfd73a282217",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60e291ec-4488-41de-8127-68ef58e9954d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8c35f22c-4169-41a8-844d-5625e1bd5781",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f9745542-63f3-41bc-ad44-cfaabb0b867b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-26T11:35:32.5664134+00:00"
},
"company_sector_id": "c03f77d0-4940-4ece-979a-540006d3e36d",
"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": "a3565260-27d1-4cde-8444-66e2a96cb152",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "75312aba-2661-4d91-bd61-4e778535b970",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd20dfc4-b27a-4476-a773-eb16121366dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "e71d87c2-7fe0-4f8d-9320-64da3ec1d0a1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-26T11:35:32.5664134+00:00",
"id2": 60
},
"db_language_id": "c8228f3e-b028-4652-988f-0c9c8d9f0cb5",
"db_language_code": "sample string 7",
"db_title_id": "69e3ca97-4a52-49eb-a44a-b97e154f0c9b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-26T11:35:32.5664134+00:00",
"create_date": "2025-10-26T11:35:32.5664134+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-10-26T11:35:32.5664134+00:00"
},
"modified_dateutc": "2025-10-26T11:35:32.5664134+00:00",
"id2": 22
}