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": "b9b6994c-7d1f-4ac7-84cd-1920a4204763",
"_parent_id": "ed25e9bf-4aef-4092-9a86-cd8c9a6dba5f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4f0128d3-7ea0-4c56-9145-29043abd1b4f",
"company_id": "013a6cd6-0155-485d-bccd-fd0f481362aa",
"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": "94c85c9d-7e8d-4281-9c7f-8dd64012bc1e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "69fcebff-c3c2-46f9-a3fe-a2db53547335",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3fa6aaca-1eb3-4013-99f3-4c81084450b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "090acc51-5c2f-44de-93bd-503d0a951d31",
"company_code": "sample string 5",
"company": {
"id": "e1d6c3f3-6fa2-495c-8688-7348b2f32e91",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T17:13:12.1449267+00:00",
"sales_territory_id": "8ef46413-6e1f-4036-a295-cfdaa5e4d375",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5983718-eafc-4602-8520-5a1363d8825d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8a798ff-98ca-4f0c-b3bb-dc007424d3bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a96bf850-3fe9-4208-8774-b8040eee0b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bac76c4-bebf-4ce7-9992-4e143e5408c6",
"db_currency_id": "78c04a6a-8997-4209-8cfc-ddfaada1381b",
"db_language_id": "060425a0-0710-4c2d-8882-3ec7aeb79df4",
"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-06-25T17:13:12.1449267+00:00"
},
"modified_dateutc": "2025-06-25T17:13:12.1449267+00:00"
},
"marketing_segment_id": "160cf075-bf56-43e1-a04f-616baf1692d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "904b135d-da9b-4175-aa4c-196105a48648",
"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": "c30eeafb-4d18-4fe9-ac19-cab7c0169d0c",
"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": "cab59a05-fabb-4dec-9775-ee8d16609c34",
"db_country_code": "sample string 28",
"feelist_id": "5bda53c7-f958-4ca9-83b1-9e07bf6df34f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ae343bbd-6718-4298-91a6-b1024a6181c8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "26359ab1-a67a-495d-9dfa-c0582c518cec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T17:13:12.1449267+00:00",
"db_currency_id": "efd9568b-f819-4a3e-a9e9-db81566a26d3",
"db_currency_code": "sample string 10"
},
"company_type_id": "4b472a9a-dfd8-4e70-9b46-925cb1c3b9c4",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d5bd62e-ab48-4c82-b6bd-21d897c8f4e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ff11cd6-5cb0-4d10-8fa2-b59bc1cf6e6c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e1a3fc8-0695-4502-8566-c81a692f35b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ef708c10-b5bc-4ea5-98a4-ef7622142b6b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "05f245e6-8c82-4bbf-9d70-63b7cfbc46a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "58952b69-f8c4-4cce-8d04-5553a706dfa8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T17:13:12.1449267+00:00"
},
"company_sector_id": "bc0144a5-899f-499f-be97-f6a53a37768e",
"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": "799bf787-8c05-48a2-9247-58f10b587c18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d2065b07-6847-478d-9cc3-df1fb3808e9b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "178a838f-4d1b-49b9-a600-8fad5d313e4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "2c539c0e-ecff-4629-8768-2e35eee27d4c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T17:13:12.1449267+00:00",
"id2": 60
},
"db_language_id": "2e40dd10-1110-49ca-889d-ad7cf2b01158",
"db_language_code": "sample string 7",
"db_title_id": "2e40b8cf-d8fc-44ce-8842-59c94cc7ff7c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T17:13:12.1449267+00:00",
"create_date": "2025-06-25T17:13:12.1449267+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-06-25T17:13:12.1449267+00:00"
},
"modified_dateutc": "2025-06-25T17:13:12.1449267+00:00",
"id2": 22
}