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": "5d29d899-9a58-4739-8f35-10310a308e2c",
"_parent_id": "ffb4d7a5-5c1b-4b3f-b794-a5a665891899",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "01650782-f2fa-42ce-83b4-c0bb036e5329",
"company_id": "21d2300d-3307-4b8c-8a31-9fafdf98883f",
"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": "38710b05-01b4-4c7a-93aa-5ad427d45755",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eba865f1-5957-4b6b-8cd6-5080cc14c6de",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5a0fde4d-fd86-438e-bdca-49130e405cb3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2bf7a4a3-9d35-4d6d-81d9-268541d33059",
"company_code": "sample string 5",
"company": {
"id": "83fa5481-837b-46ca-931c-6b4f578ff156",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-29T02:13:33.0279262+00:00",
"sales_territory_id": "d1b19e0d-0f57-49d7-92b5-8c35ae87ae2a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "94ed11f0-8d2e-403b-b45f-dc1c4039b6af",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30fdc4a8-949c-4af6-b084-67aa537b0112",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e0165d6-0af6-4b01-8d1a-674adeadcba8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ccb13ccc-85c3-4a50-b7df-8939eba91ec1",
"db_currency_id": "eb7cb915-9399-4382-9bbb-a656d3c0f6df",
"db_language_id": "3554d869-9c8a-4ded-a13a-c1b7ce83acb6",
"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-29T02:13:33.0279262+00:00"
},
"modified_dateutc": "2025-11-29T02:13:33.0279262+00:00"
},
"marketing_segment_id": "29c8b17c-1ac1-472f-8c79-5788ea5807ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "be3fd814-017b-41af-b89e-c263ccf7877a",
"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": "f01bcd10-0779-4574-8914-8042c8ecce4c",
"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": "1994fded-5e15-4939-a9f7-8a8d282561fd",
"db_country_code": "sample string 28",
"feelist_id": "77c53ef1-0618-452a-9a4d-9f555b8c53d0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f2d5b003-51de-4717-a329-fa974ebf0d85",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7c8f2f90-1214-4dfc-9506-2270db4c0d57",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-29T02:13:33.0279262+00:00",
"db_currency_id": "09aaa2af-bfe4-40b6-82a3-81ff10349e64",
"db_currency_code": "sample string 10"
},
"company_type_id": "57758a0f-205c-43e9-bf45-b332cd3af208",
"company_type_name": "sample string 32",
"company_type": {
"id": "233564dc-8f3b-4b9d-9a04-aeb7fd24fce4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "10d33fd7-7903-4903-a1f2-61067cd7d975",
"sales_organization_code": "sample string 5"
},
"db_language_id": "effd1c26-1d66-4198-b723-a1656c608a7a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e5bd910f-b53b-4a6f-b122-25a7ca16b59b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7fe72351-ff7e-4eed-991f-3a8c8d330f95",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d1fd1509-1783-4a1f-8a4a-490dd85aa3d8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-29T02:13:33.0279262+00:00"
},
"company_sector_id": "559a6452-90aa-4106-8fbc-557a17891a04",
"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": "039fd940-c943-4dba-95ac-02879cdc62dc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "21241731-a2a0-4c29-b934-90acbedc3899",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b35d0459-37ff-4d73-8be7-b6189376dab3",
"account_manager_user_code": "sample string 56",
"company_status_id": "3000dfcf-b4d5-42ee-9551-0071169fc718",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-29T02:13:33.0279262+00:00",
"id2": 60
},
"db_language_id": "90fe92df-21be-46a2-8934-0c963d351277",
"db_language_code": "sample string 7",
"db_title_id": "572bab6a-20dc-4708-81c6-8f482cb50331",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-29T02:13:33.0279262+00:00",
"create_date": "2025-11-29T02:13:33.0279262+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-29T02:13:33.0279262+00:00"
},
"modified_dateutc": "2025-11-29T02:13:33.0279262+00:00",
"id2": 22
}