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": "3da9b589-3ab2-41b4-a2fb-de342f898e33",
"_parent_id": "71b702be-ba2c-4170-b542-34c5743604ae",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "83ab2d65-eaa3-46a9-8984-382ff2b6aee2",
"company_id": "a9ae416c-920e-4f8f-8abc-05045e607835",
"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": "f91d6831-67ae-4256-823b-233aa38ad8d3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c9e7fa46-4e32-46db-aa7b-50d61a6a93c6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "07be1bdc-5ad4-4f4e-9b6b-0cdbed348045",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "583ed62b-7525-4828-abfe-206607c8d185",
"company_code": "sample string 5",
"company": {
"id": "3bf6e818-5a7e-4dd6-a768-efcd0535d714",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-19T00:23:49.7276783+00:00",
"sales_territory_id": "362ea998-90ed-4e84-b707-48ee0d340d10",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "27b267c7-155d-431b-b342-3946d4e8c7c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a2bbdbc-2dca-4b11-9e2b-a5823f9d1674",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d68d07aa-890f-41a6-9f37-e42e9bbd8503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ea6d59c-807b-424b-9dc7-3c2733cbca36",
"db_currency_id": "00dd8ea4-a57f-4853-97cd-75514071d8bc",
"db_language_id": "2ff657b0-701f-48f1-b175-f71ce374104b",
"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": "2026-03-19T00:23:49.7276783+00:00"
},
"modified_dateutc": "2026-03-19T00:23:49.7276783+00:00"
},
"marketing_segment_id": "ca1d0806-8d8a-4c7e-a464-02fe81d320d4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "06829598-0eec-48a1-88b1-62638465d311",
"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": "dead00c9-9eae-44db-be96-e12e164051f3",
"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": "e475fd30-67d5-44c2-aece-4657618680b1",
"db_country_code": "sample string 28",
"feelist_id": "8d9eeb9d-c811-4a77-8785-6c00bc3ae329",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a0b5b35b-75dc-418d-a80a-e77a3cc42f96",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3685d2dd-a428-4723-93ad-291b794cad4c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-19T00:23:49.7276783+00:00",
"db_currency_id": "d79b4f0b-ffef-4ee3-a1fc-e5b292f52ad1",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1fe2519-5950-4b04-82bd-f614b1bc7309",
"company_type_name": "sample string 32",
"company_type": {
"id": "abf6a32f-06e8-4b5e-93c7-037050f34ee9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b594d2e0-0c01-49e8-afc2-d1868e7a4666",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4fe5b93-ae46-41bb-978a-b85052e0f98f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e7d188a-90cc-46b1-a670-a4a0483030f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "87ba147d-b51a-498c-b3ee-2f9694f38283",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8c58dd78-1eb0-4d0f-93d9-089508a57e68",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-19T00:23:49.7276783+00:00"
},
"company_sector_id": "09166030-762c-478c-859d-eac1220f0b44",
"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": "a1549a56-6660-46e0-8e46-31daa01cd495",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e662cb9d-d84e-4906-8ca6-379a78063b75",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9f8bc525-da4f-4d7a-815d-dfac5f3124f5",
"account_manager_user_code": "sample string 56",
"company_status_id": "75349a27-ab92-4979-aab2-26a52ca4face",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-19T00:23:49.7276783+00:00",
"id2": 60
},
"db_language_id": "e231c1e9-cee2-431c-9544-2f8ed091cc08",
"db_language_code": "sample string 7",
"db_title_id": "22294380-aab4-4e4a-ba6e-d87a839dcb27",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-19T00:23:49.7276783+00:00",
"create_date": "2026-03-19T00:23:49.7276783+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": "2026-03-19T00:23:49.7276783+00:00"
},
"modified_dateutc": "2026-03-19T00:23:49.7276783+00:00",
"id2": 22
}