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": "ed8f6c72-a462-489c-8fb5-338b44d12a7a",
"_parent_id": "62f72c61-94a6-4a3a-8741-020abe0fffee",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1aa3b3e8-8e14-456c-aa62-cbff952329d7",
"company_id": "cd768815-6ba5-4a30-a695-3cce24b46def",
"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": "dedbbbd4-c51a-485d-abe6-2ee549e0023e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "422adc60-e6eb-4a03-9159-ce0d2fc8960c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8dc99071-f5d4-4c72-b726-187f1afedcfa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "11c4474d-cc61-4a8d-8f1d-cd4078bbb9fc",
"company_code": "sample string 5",
"company": {
"id": "48f51ed2-0ce9-41c6-92c1-0fe59077a0cf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T05:26:22.8862003+00:00",
"sales_territory_id": "81142fe4-e37f-40de-8645-47fc17250812",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f72a2c26-5517-4da6-beb7-4f13c5c2a922",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "524199f1-daf5-410e-9f7c-99a12840ea01",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63e2758a-695b-4fae-83f3-ce42dc968c30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a9d863c-4b5e-4aaa-9cb8-4ac0b576b2b2",
"db_currency_id": "dc232af6-da6e-479f-a785-5aa2e9f1b371",
"db_language_id": "c661af49-8d92-40ae-b689-a2c91a907d38",
"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-09-09T05:26:22.8862003+00:00"
},
"modified_dateutc": "2026-09-09T05:26:22.8862003+00:00"
},
"marketing_segment_id": "669d00fc-844a-4a72-a59a-f97fd2be7464",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "67482adb-3e7a-4d83-adf4-c1fc1c36fdef",
"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": "13d15cbd-9068-46d3-bfa2-482d0017712f",
"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": "81dd8b16-c28d-4e9c-8bc4-d1897abd321b",
"db_country_code": "sample string 28",
"feelist_id": "1372643a-269f-40fb-9f06-8b18e08a13b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3704eead-9290-489a-b460-309a561d534f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "553d8a5f-abd7-4f7c-9622-135db476ad6a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T05:26:22.8862003+00:00",
"db_currency_id": "56de94a6-0462-441d-b872-97cd41319b0b",
"db_currency_code": "sample string 10"
},
"company_type_id": "ab00db84-833b-449c-96b5-6066ada412dc",
"company_type_name": "sample string 32",
"company_type": {
"id": "f6641ed3-7e1c-45ce-8e55-c936a684e306",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ab1b779-7295-4f93-9f23-7873c3267535",
"sales_organization_code": "sample string 5"
},
"db_language_id": "488deb9f-4d3b-4fde-859d-f257cb7142c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1fc52886-5560-4ab6-a18e-2b53f886c5c8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7b821f98-a93f-4ed9-9ab6-96c5accf7767",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4e4020b3-1434-47e0-8371-a2c9bb2dcf14",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T05:26:22.8862003+00:00"
},
"company_sector_id": "a8c6b5c7-0ebe-4cc9-acfb-b2b85b84be6c",
"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": "89edf6bc-ee96-49dc-908a-287fd2cdfd6b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0646466-3705-4858-b9e8-7c1749f705ca",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0504c58-b097-4971-80c7-c92f401e19ed",
"account_manager_user_code": "sample string 56",
"company_status_id": "540f86df-5aab-42b0-a8b9-787729cfd813",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T05:26:22.8862003+00:00",
"id2": 60
},
"db_language_id": "18c91d94-e26c-4477-9649-700e099e3777",
"db_language_code": "sample string 7",
"db_title_id": "96502b0d-5477-4904-b7c4-77667c5cdeac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T05:26:22.8862003+00:00",
"create_date": "2026-09-09T05:26:22.8862003+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-09-09T05:26:22.8862003+00:00"
},
"modified_dateutc": "2026-09-09T05:26:22.8862003+00:00",
"id2": 22
}