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": "17470777-301e-4f5a-a7b4-dc64d7fc3451",
"_parent_id": "e147d452-ab9e-4f1a-9a49-7cd224a29d99",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "be7dd03f-733f-458f-b052-78595365e3f4",
"company_id": "ea745cf8-1761-458c-87ff-9eace17414ce",
"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": "a6f67770-2893-4fde-9811-58a85deb6534",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "721b0327-22e6-4c03-b3fb-096da93af0c4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dc43d07d-a266-41d5-9f89-6126d732d56e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a83116bc-15f2-41e5-affd-afdfa2f5f2ce",
"company_code": "sample string 5",
"company": {
"id": "cdefcb09-0335-48e8-93e5-8272c49da121",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-20T06:23:42.9632775+00:00",
"sales_territory_id": "e7502f04-e9e9-4b59-b6b0-75daa7e32b00",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "730c6ddd-b337-4fd5-bc44-c54698885804",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a0507fb-02ee-468c-a86e-f7ccfdc15a58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eebeb0fa-778a-4e39-aa6b-f56b02574ae6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b401eb1-c91c-4d85-b36b-f051f7338604",
"db_currency_id": "b8e747c5-14ca-4944-8826-291e6c9a6710",
"db_language_id": "014bec2c-01ea-4ed5-beb6-c6a32441d28a",
"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-06-20T06:23:42.9789028+00:00"
},
"modified_dateutc": "2026-06-20T06:23:42.9789028+00:00"
},
"marketing_segment_id": "7c8c8d73-dfd7-4eb2-bdaa-d6dc628aa14e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a93bdb83-de27-4032-afd3-4f8b9b2f572f",
"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": "ce6a1788-53ec-418e-92ea-495e9d15dd63",
"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": "3d8b9ac7-b41c-44db-b189-5cfe610ca249",
"db_country_code": "sample string 28",
"feelist_id": "f306e8c4-9ee3-49e8-94b7-4984c247a0a1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "edf917c7-e880-4533-9ae6-585d54455f2a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e065adbc-d370-4380-9402-6cf424139d2c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-20T06:23:42.9789028+00:00",
"db_currency_id": "33fff2e5-22aa-402c-86a7-f8c4745a7d9d",
"db_currency_code": "sample string 10"
},
"company_type_id": "0bf0de81-40ea-43d1-96f9-04a1f4918d45",
"company_type_name": "sample string 32",
"company_type": {
"id": "de185c17-638b-4d6d-9439-490fa219d33f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7abc0a0e-baf1-4ab1-9f70-bd39b2c19e3b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e5f38685-ede7-4873-b9b4-8a5cb0e618db",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b164ce7-c96a-40a7-9367-63c707c3b61f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "808ad410-8195-4bd9-b542-f98031623d0b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e622e49c-4671-4ef8-af0f-d7a354d45ac5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-20T06:23:42.9789028+00:00"
},
"company_sector_id": "7aa14703-847c-42f9-91c2-033d9b0dd0c6",
"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": "15e1c7e5-f8ac-4df8-9c56-fd117f507fab",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "778c9bd7-7a74-483d-8a27-d4dcfec2c55d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4b22e30b-f571-4d1e-a2c8-a64e838447ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "c732fd0c-73ec-4544-975b-8e788e7b4910",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-20T06:23:42.9789028+00:00",
"id2": 60
},
"db_language_id": "4e446a32-0b3a-4d2f-aa74-0eb92a8a810f",
"db_language_code": "sample string 7",
"db_title_id": "cb963278-b3c5-4071-be20-aff86dac5d2f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-20T06:23:42.9789028+00:00",
"create_date": "2026-06-20T06:23:42.9789028+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-06-20T06:23:42.9789028+00:00"
},
"modified_dateutc": "2026-06-20T06:23:42.9789028+00:00",
"id2": 22
}