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": "e7be2c17-6505-4db8-ae91-037d05bf82b2",
"_parent_id": "8e04eb17-aefd-49f6-8e08-4d1e812d1a78",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "22a862ff-4262-4536-936a-a5c5ffe90cae",
"company_id": "7043e887-608b-410a-a981-e4ade6f8afcc",
"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": "e35e2d78-c284-4b92-b710-4cc2c19bd98c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4558a0d4-bf7f-4d09-90e3-51772ce98262",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b0210c77-adf9-4ced-8061-d086e98d91bc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f525dc82-b069-43cb-a041-a28b326cd7eb",
"company_code": "sample string 5",
"company": {
"id": "2e0e605f-c3cc-4f9b-9621-6891b9f15574",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-02T07:56:06.2016876+00:00",
"sales_territory_id": "a0b11bff-cceb-4f73-a393-57ef3b550e34",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cf8fb75f-94cf-4c19-9c4b-7f9b908167da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9717e452-65c8-4edf-9342-fa6ece16ccd3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f890ba2-eec7-4e1b-babc-b5fc808f8a9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6524c38a-b156-4eca-83a4-481f56cb5358",
"db_currency_id": "c7b28c96-4a0f-4bbe-a7b6-7a1c0fed8d12",
"db_language_id": "941eb5db-b093-4a68-ad9b-4f2d6b7be185",
"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-07-02T07:56:06.2016876+00:00"
},
"modified_dateutc": "2026-07-02T07:56:06.2016876+00:00"
},
"marketing_segment_id": "bd1353ae-a6d4-4af0-a4c2-7a472517fad9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c4af590-e6e7-4cba-9d7a-824a62cb740e",
"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": "8cfa6cae-77b9-4fbe-b131-76538ca6db61",
"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": "5b30568d-69df-4591-8b0d-982b60d14b08",
"db_country_code": "sample string 28",
"feelist_id": "ecc83a97-c7e7-4164-bb1f-65cbe10f1697",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dbccaa8d-cc21-4f9e-8ea2-100144d9dc64",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2653da9f-06eb-4527-bf69-4d5a33989423",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-02T07:56:06.2016876+00:00",
"db_currency_id": "0f999259-b2e3-4627-a878-793d8a10999d",
"db_currency_code": "sample string 10"
},
"company_type_id": "76e46850-15ca-48ac-960f-9c7cba3936bb",
"company_type_name": "sample string 32",
"company_type": {
"id": "e3a33aab-17f2-4b97-af51-d1e67425fbbe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc3f3c94-042e-4974-b6cb-7f459d484ecc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "daa3edd7-5ec9-4046-b80a-bd41fc17d18e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a92dc9c9-3f82-4fb8-9e2f-3677143d6d12",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb88f248-4856-4a8c-a993-09a8ace0bd85",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "94745209-0b56-47a4-9839-56b974a9b83b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-02T07:56:06.2016876+00:00"
},
"company_sector_id": "e6113cb3-368e-4edf-a5a9-b8bef962c389",
"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": "6813e2e3-33c6-40bd-8b4f-2ba2c5cf9395",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52409fba-b5e3-451c-9120-05118aef52df",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6f320c9c-262f-4257-8811-657e2b4d9b8d",
"account_manager_user_code": "sample string 56",
"company_status_id": "77152a9b-6509-4836-8639-a30287d28d6d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-02T07:56:06.2016876+00:00",
"id2": 60
},
"db_language_id": "ccb0d062-7dd7-4ec5-8fbb-44616b993449",
"db_language_code": "sample string 7",
"db_title_id": "a5c50d6a-7628-4911-9411-c34eada83cd9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-02T07:56:06.2016876+00:00",
"create_date": "2026-07-02T07:56:06.2016876+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-07-02T07:56:06.2016876+00:00"
},
"modified_dateutc": "2026-07-02T07:56:06.2016876+00:00",
"id2": 22
}