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": "07eb7e00-7377-4010-9235-c77eaf47f03e",
"_parent_id": "641c43ad-99a4-4712-84fe-3059002d66d9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1764439c-4bf8-424c-81fa-cf836d2c4483",
"company_id": "f95541a3-7244-476c-8ba4-9a6fd02e3f47",
"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": "6b7ac22f-55b2-44d3-a0f3-ea963e1215bb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bc1de368-c961-4c13-9d4f-2f7e4d3d41b1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "86b34dce-d774-4782-91f9-6561b8b7ea2c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a1961482-1733-44a3-9a0c-3652615addd8",
"company_code": "sample string 5",
"company": {
"id": "d21e680e-0779-4e89-b198-15c241025352",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-14T03:52:48.2507538+00:00",
"sales_territory_id": "a46c885c-4f82-4500-bc86-6c4c52f1acbe",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b881b699-5516-4809-b812-9a3ef829af30",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "117c04db-abd5-408d-8295-776250cad6af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2914fa96-b215-4bf5-bb8c-1a328b814bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25628556-ad3d-44f7-95fc-f278117f1fed",
"db_currency_id": "05c2ba20-8093-438c-b8d3-01f7e5f6d76d",
"db_language_id": "7997e59c-a25c-43ac-9704-a5013731199f",
"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-09-14T03:52:48.2507538+00:00"
},
"modified_dateutc": "2025-09-14T03:52:48.2507538+00:00"
},
"marketing_segment_id": "dd6f534f-c2fe-42c9-8b9f-74e8f8ec0549",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c89d4171-2c0e-47c8-9613-0042678234eb",
"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": "bc1d812c-1d11-41f0-bf81-c05f3f91970b",
"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": "358e62bb-7868-4a45-bbc3-a2da1a46533e",
"db_country_code": "sample string 28",
"feelist_id": "afdb771b-3d81-4ac9-9e7b-1afa9a3e84e4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "208c2807-bf53-4547-bcfa-b5d9fa724564",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0c607037-cef7-4307-beda-4f2f4ea4ede0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-14T03:52:48.2507538+00:00",
"db_currency_id": "2f38d963-5ee9-42a5-8797-d7048c146984",
"db_currency_code": "sample string 10"
},
"company_type_id": "5d1c3af0-c163-4108-851a-224509e14d6f",
"company_type_name": "sample string 32",
"company_type": {
"id": "b665088a-e84f-475c-abda-5e9fde365be3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0e8128c-8c53-423f-ad53-7a3a8b05fffc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "41f039bb-23e7-4f2c-a265-f86ffbc3fe72",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1bca3a07-4cf1-4cee-9dc6-c58ea5d91e98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "880a059d-aa94-4f1d-bd65-92c4a3bb2918",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4295a95-b193-4828-8754-f25563126651",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-14T03:52:48.2507538+00:00"
},
"company_sector_id": "d2525aa8-be94-4556-aeaf-5ae76e31d23a",
"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": "25f8bc0e-0275-402e-89df-f699e64b5757",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "97c4dd1f-086e-4f2d-b672-e9e1d1b7afa9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b9114cde-bd91-46ea-9bd5-0c3a717e1843",
"account_manager_user_code": "sample string 56",
"company_status_id": "d934b8bd-b8e7-42f0-9da0-bb4ffe883763",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-14T03:52:48.2507538+00:00",
"id2": 60
},
"db_language_id": "ca4cb7de-49f3-4878-ac51-9c5e41b5914c",
"db_language_code": "sample string 7",
"db_title_id": "0bcf9222-92a2-4924-9120-31b138be5e3e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-14T03:52:48.2507538+00:00",
"create_date": "2025-09-14T03:52:48.2507538+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-09-14T03:52:48.2507538+00:00"
},
"modified_dateutc": "2025-09-14T03:52:48.2507538+00:00",
"id2": 22
}