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": "c05a38e5-3682-4225-a014-11ce53fc9627",
"_parent_id": "b2de37ae-b96d-493a-86d6-71b6c98a6437",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e009cb0d-8cf5-44dc-a5ec-e7d7b2e4b62d",
"company_id": "2d4f062a-19ba-417e-b771-4fa384cf99db",
"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": "bec14262-aec5-4818-977a-95c101d036b4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f0a06a17-0cf3-4f29-8bcb-6e4a5651edd7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "762eb987-9348-43c2-8a30-7b52de4a3372",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "828439a5-0b49-407f-95c8-6b9a0f1c2433",
"company_code": "sample string 5",
"company": {
"id": "fa42b889-bbda-4cf4-9151-36f5b2329959",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T02:38:50.4039688+00:00",
"sales_territory_id": "44d2c05d-9cd0-4c54-941b-adb73c7d26ca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3c998473-75e1-49d1-9f9e-3643b528417f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "22685cbe-0c39-495f-9ab2-1b215e13090b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd3fea7e-d157-4ebb-972b-be90684954f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d09b1cf7-ad02-4f32-a686-ca498f4a328d",
"db_currency_id": "0fae596c-38d8-4e90-932c-560651a0cc36",
"db_language_id": "4db07c98-9599-474a-904c-721744fc7560",
"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-04-03T02:38:50.4039688+00:00"
},
"modified_dateutc": "2026-04-03T02:38:50.4039688+00:00"
},
"marketing_segment_id": "0c9153e3-bd13-470b-9523-5933fa47d588",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9af04930-2726-499e-b585-442aeb4e3646",
"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": "fa8090bb-48f6-4ee4-94ae-5d5e94d4cbe2",
"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": "06ab57fb-378a-4cf3-98c0-e231fe96913d",
"db_country_code": "sample string 28",
"feelist_id": "4bc1eba1-5282-4558-b623-abdb7d4825a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ea74e960-f097-4505-9dc8-b988fbb903ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d564a77f-f4fb-4a3a-9b3e-614f7694ce63",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T02:38:50.4039688+00:00",
"db_currency_id": "f81587b2-da5b-4a75-894c-2914ea87a4cc",
"db_currency_code": "sample string 10"
},
"company_type_id": "2c2699cb-d5d5-40d3-9692-1a3e720a2a9e",
"company_type_name": "sample string 32",
"company_type": {
"id": "59b68f92-e133-47c3-972b-ce6513784c53",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a207ddb4-c925-471e-bee9-01eaabbc2316",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b3254cd2-53fe-4bea-af3e-5e5afb83110f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95b06442-3cc0-4c82-bcf2-5528769e6b27",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7e354740-6885-465d-ba3a-d0aada7dcdec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "931ee2c2-6af2-441c-90b2-9b681f00d9b6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T02:38:50.4039688+00:00"
},
"company_sector_id": "90f855f7-0ec4-47a9-981f-a941c6ceb6e8",
"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": "0b2402fa-f43d-4956-a8f2-36dbeff9df71",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "088de8ab-93f1-400d-982f-794e33da5e1c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e753112-5f8d-4020-888f-af7b481864bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "dc896f39-0e97-4665-990f-adeeb535604e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T02:38:50.4039688+00:00",
"id2": 60
},
"db_language_id": "03b2680f-b7c6-47ea-82a3-78360eaec357",
"db_language_code": "sample string 7",
"db_title_id": "d4063c75-a69e-45a4-b911-376088937cd7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T02:38:50.4039688+00:00",
"create_date": "2026-04-03T02:38:50.4039688+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-04-03T02:38:50.4039688+00:00"
},
"modified_dateutc": "2026-04-03T02:38:50.4039688+00:00",
"id2": 22
}