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": "b3916791-0656-450a-b666-d9447f65c201",
"_parent_id": "2090abfc-7be5-4cce-b445-b82da50f94f2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "92967524-e303-4def-977e-379266940404",
"company_id": "ef370414-add6-438f-8b18-fecc0d5627b8",
"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": "e67b9151-d758-46df-812e-a300b5565b04",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b81a99b1-33cc-4db6-b580-b214673617cb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e27b754d-a172-4282-aa1e-d5abb3556033",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a6d47c3c-de10-41cb-bdd4-51149470d23a",
"company_code": "sample string 5",
"company": {
"id": "e1c710e3-a333-4442-8b02-4fb37a711462",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-10T14:02:39.117326+00:00",
"sales_territory_id": "3cf0cf88-7611-42be-9548-e030d120a0fa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b14e355f-93cb-465f-adfa-181293573545",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3e6d5593-4424-4261-8fc3-d05bc40e1918",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "56c4cadf-cc3c-4d30-9ffa-4d8032bd7a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d01ac1b-7237-4c2b-99d3-0a08d2d28eec",
"db_currency_id": "a82bda2b-4c0a-4143-a977-9e94204406c7",
"db_language_id": "a6c870dd-3196-48ff-940e-cb97379cfac2",
"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-07-10T14:02:39.117326+00:00"
},
"modified_dateutc": "2025-07-10T14:02:39.117326+00:00"
},
"marketing_segment_id": "ca3d04f0-c012-4395-971c-cecd69557a0d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b4de4763-de6c-4092-8fb0-b7b07e6ddd4f",
"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": "5687e120-d691-455c-81ef-1f7d637fbda9",
"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": "74e095f2-db1b-482f-be13-f09c03cbd25c",
"db_country_code": "sample string 28",
"feelist_id": "c7883dc9-a737-45dc-9e43-371ad2ee0ed9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "24e518c2-a19f-4161-a32f-b6b372cc15aa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ef16b9e7-9fed-4d82-b739-6b1c8ce306bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-10T14:02:39.117326+00:00",
"db_currency_id": "5b192ed2-b7a9-48bb-805f-22fe259100a2",
"db_currency_code": "sample string 10"
},
"company_type_id": "0913d5ea-8776-47ba-8abd-9414269dd9dd",
"company_type_name": "sample string 32",
"company_type": {
"id": "bcd7d938-c8ea-4176-91b9-09916f90d5f8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "927e6489-f8b6-4287-8f0d-c291d0930cad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f5c5454a-2eee-441b-a43c-a62f66fed39c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2d46770d-e9b4-4214-88c7-6f9750d10631",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c35dbd2-b60b-4f7e-94dd-f0585ba3ef6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ac28075-5b1b-4700-9e35-d28f2885bb05",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-10T14:02:39.117326+00:00"
},
"company_sector_id": "86167991-cfe6-480b-8ca0-b513cdceb9f9",
"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": "cc0e372e-a608-4771-8f47-feaa9e49045e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "551dba68-ae1d-4036-9417-2b0fcc15565d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6a142643-703e-47bd-aa7f-472bbee817db",
"account_manager_user_code": "sample string 56",
"company_status_id": "ca838cc1-e525-4fb5-acdd-98420e6c6fba",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-10T14:02:39.117326+00:00",
"id2": 60
},
"db_language_id": "2e552f59-4fd4-46f5-8d50-24153c888288",
"db_language_code": "sample string 7",
"db_title_id": "4855ac5b-2833-4a43-a7e2-6c3110b71441",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-10T14:02:39.117326+00:00",
"create_date": "2025-07-10T14:02:39.117326+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-07-10T14:02:39.117326+00:00"
},
"modified_dateutc": "2025-07-10T14:02:39.117326+00:00",
"id2": 22
}