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": "cdff2b7d-5ce6-4c80-a8b7-3982b53a0299",
"_parent_id": "3eb32b05-e376-419b-bf87-3291a60bd5d4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b34a29d-ca5c-400d-85a5-da2e05ef996f",
"company_id": "3d3978e1-1f3a-4111-a0e9-e3894ab7d3a1",
"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": "151b359e-7aaa-4431-883c-5d1daae2169e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aca85ea0-ccaf-45d8-bb7f-b5b56e0ae970",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c0d7722b-5951-4921-8c99-6c5f15ba5af5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e56e350-67a4-44f1-9817-9033215b3791",
"company_code": "sample string 5",
"company": {
"id": "a7bfba2d-9086-4511-b6bb-bd96693efd91",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-07T12:43:07.8952606+00:00",
"sales_territory_id": "0a7d4da9-a0fe-4401-859f-545475c481c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c2f936ba-549e-4bf7-ab1e-6a5cf839f066",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8d3ef2d-f0d2-450b-85e5-0cb36a74117f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba44bad8-5ebc-4031-a21b-acb643d09981",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9326d4a-be2f-4502-844c-faa730928be5",
"db_currency_id": "d3626ac5-c194-4ab9-8f0f-519c9293071f",
"db_language_id": "7924c42d-f499-46cc-aa79-b61ded761ec7",
"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-08-07T12:43:07.8952606+00:00"
},
"modified_dateutc": "2026-08-07T12:43:07.8952606+00:00"
},
"marketing_segment_id": "cf287597-d7f5-493f-88ae-3049ed1fb701",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c2e6b218-b852-4ef5-bdd4-e4567eeda03a",
"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": "e03d2e89-0640-4697-809f-8e80014bef5f",
"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": "57bffce5-e798-4ccd-a2f7-9cc01377d7f0",
"db_country_code": "sample string 28",
"feelist_id": "a596732a-5f5a-448f-aeb3-8af758c90a45",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "aea5bcc4-b3c5-4cbf-bc58-2d58ba677563",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2e78284-beef-4e96-afe4-675247e9fb30",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-07T12:43:07.8952606+00:00",
"db_currency_id": "7172c055-2c59-494c-a769-13cb3297ed45",
"db_currency_code": "sample string 10"
},
"company_type_id": "273bbf6f-969a-41f6-a6ae-ff351457c399",
"company_type_name": "sample string 32",
"company_type": {
"id": "f3764deb-0849-4bec-ab92-6d59bde804ac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6e7169d-9c2c-4842-85e2-6e0ed7fd5bd3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0748e8e2-032b-44a1-b0d0-e945ab319896",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ebd3d6e4-e980-4929-b495-1e1120ea0ea9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "91d92aa4-4cce-47b8-bd73-00bec7e043ec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ae4ec16-f660-4f63-9a50-ca3300d033dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-07T12:43:07.8952606+00:00"
},
"company_sector_id": "24200ad5-5301-4705-8b34-4d3cbc8aec99",
"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": "a0beee42-e19f-413b-9f41-ee5375b7392a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2a959d4-81c3-4b87-8846-63f3cd77cadf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8cb66ef4-643c-4751-9846-0d8b2b26708f",
"account_manager_user_code": "sample string 56",
"company_status_id": "484b997d-950b-45e3-9635-46f741e93f3c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-07T12:43:07.8952606+00:00",
"id2": 60
},
"db_language_id": "b7ae9cc1-3dde-45f9-84f2-e7a6d7691117",
"db_language_code": "sample string 7",
"db_title_id": "4cf61af8-4ffe-4f09-85a9-56fea9332fcd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-07T12:43:07.8952606+00:00",
"create_date": "2026-08-07T12:43:07.8952606+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-08-07T12:43:07.8952606+00:00"
},
"modified_dateutc": "2026-08-07T12:43:07.8952606+00:00",
"id2": 22
}