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": "4389be0a-f8e9-41a3-b01b-3d425757a44f",
"_parent_id": "0ef74c91-8f5c-406d-a07b-77608f9ce68c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1960193b-c743-4a7c-8985-9abda0159c32",
"company_id": "a62a6daa-45be-4fd3-8ff1-a668d3ca7cd9",
"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": "a47bd3b0-482d-4a61-958d-038c6a8e5e57",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e60cdc72-7275-469e-9819-df16ccad25c3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f44210e7-c9c8-441d-822e-b7e4980b2bf5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a48bfd2b-306e-42f7-86b1-e62d70488581",
"company_code": "sample string 5",
"company": {
"id": "90afca71-ef92-4cfa-9056-bdf677aca53a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-19T01:14:24.3594261+00:00",
"sales_territory_id": "c5dc30ea-bdee-4ad8-8943-af273e92793e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9bfc1c11-4e44-4e17-b4a9-f8d905e9e5c7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ca437581-9df5-43ba-829c-48a3593f2feb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5d84af8-6caf-4331-988f-cfc9ae4fc789",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe7183d2-35d7-4c46-b6c3-d3d18dbf8343",
"db_currency_id": "518ee8ed-0e5b-4eef-9616-37904999b318",
"db_language_id": "a1877367-d527-4f6d-9a35-e9d59dece9a7",
"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-19T01:14:24.3594261+00:00"
},
"modified_dateutc": "2025-11-19T01:14:24.3594261+00:00"
},
"marketing_segment_id": "6af2dae3-75e9-460b-b622-0bfb909b373d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "998cb095-2572-46f6-9e67-7f9e189230ca",
"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": "83c85783-3654-46f5-8ad0-27e93c5fec2a",
"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": "30eb8c21-ac30-4654-aecc-feae487d6c0a",
"db_country_code": "sample string 28",
"feelist_id": "e656a311-ee44-41e9-a43e-df90485cfbb5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8fee9852-d4d5-4dba-9400-da1be6b43719",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5ea49816-0a73-4502-afad-445c64362011",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-19T01:14:24.3594261+00:00",
"db_currency_id": "803d6656-f567-46e1-98af-06a7ae61c31b",
"db_currency_code": "sample string 10"
},
"company_type_id": "5759d2aa-bc16-4135-aba5-ff3cc282e6e7",
"company_type_name": "sample string 32",
"company_type": {
"id": "2324d99a-e485-4df5-bef9-dd779634fda7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c979a09-b6b6-4df1-a98d-b748d3112c61",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ee9cfa9-2b8a-49ee-873d-260307b81de9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7364217a-318e-4a53-9e7a-65027841e7f2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "efb3c803-dbb2-4475-ae15-f6baf09aefd2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5751c69a-2b3c-495b-a863-7a1cb875efe5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-19T01:14:24.3594261+00:00"
},
"company_sector_id": "7013497a-c688-4a27-b9ae-d9948dc855ff",
"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": "e9b5b200-0b97-4c39-88cb-2b337d134ee2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ff3c924f-ce35-4051-843a-4a39576e955d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e6e969e0-cdfa-41ee-8909-9cb449c3563b",
"account_manager_user_code": "sample string 56",
"company_status_id": "e8bf5cb7-768f-4453-ac97-7812bf00bb15",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-19T01:14:24.3594261+00:00",
"id2": 60
},
"db_language_id": "2192c302-36d8-4298-87f9-a40312852458",
"db_language_code": "sample string 7",
"db_title_id": "8d699c51-e8c0-46f3-8cba-bcdacc13d77b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-19T01:14:24.3594261+00:00",
"create_date": "2025-11-19T01:14:24.3594261+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-19T01:14:24.3594261+00:00"
},
"modified_dateutc": "2025-11-19T01:14:24.3594261+00:00",
"id2": 22
}