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
{
"id": "238b7299-a00f-441a-88b2-0652a5079a23",
"_parent_id": "dcb983b4-5860-43a3-b1b6-534520391b44",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "240783b9-56ae-489d-91a9-c21f61d9cf18",
"company_id": "63219183-489a-4bfc-ba62-c4c96c507bf3",
"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": "07d17ee3-d17f-40d8-9c4b-b7ef151edfd8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8e835aa1-f720-4f34-9fc2-4bfd0fb2e925",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e4c93ce8-bf83-4989-afd2-4b4e8537c3ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1471608f-572a-4331-bf81-0de8f638bfad",
"company_code": "sample string 5",
"company": {
"id": "3ba8bcf9-56c8-4850-8e38-900b008819ea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-16T08:22:32.9287357+00:00",
"sales_territory_id": "2e9b8772-cece-4a76-bf6c-3b173b51dd46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec4da6c0-b57e-43f1-b0b0-6e4ca9346ec6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8f579d4d-cb6f-42c4-b405-b398dfb754f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96511b29-86f0-4931-bcda-d58b8bfd309e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "518518d4-4ac2-46f5-8d85-e9fa0ebcfd3b",
"db_currency_id": "b0243420-0c94-465a-a29b-e4aefc78a7a1",
"db_language_id": "0a74cc9c-adfb-4d17-99ce-1eb64b375cce",
"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-11-16T08:22:32.9287357+00:00"
},
"modified_dateutc": "2026-11-16T08:22:32.9287357+00:00"
},
"marketing_segment_id": "64afbd34-5536-43f2-88de-88d70f9fc2cd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c45b1e09-621d-45c9-96b3-d79fb34f1055",
"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": "5818d7a7-8da2-4242-aa4d-d779cf870344",
"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": "629814bf-d582-483c-80fd-01c0d8673bbc",
"db_country_code": "sample string 28",
"feelist_id": "0781dcfa-4670-4e65-9794-9de271df97dd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d412830b-dc1e-4b64-b7f5-f675ee195200",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a5a7c9a-90ef-4f2b-9399-4a4b8720871b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-16T08:22:32.9287357+00:00",
"db_currency_id": "998283c7-cde5-4778-93b6-e5fea0b78d06",
"db_currency_code": "sample string 10"
},
"company_type_id": "a8a66cb1-8f28-416c-bbcb-1d81130624ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "75e07132-33a3-43e5-b54d-2e0fb91ac6a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf50a46f-3fbd-476e-8c9a-3854379d5d89",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1ec22643-7650-4411-955e-739953b83f1f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9754371-94f5-4233-b2e0-f57247446edb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca476b46-2a5e-4888-8682-effbb26703a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f7393eb8-53f8-4864-9e80-8bf81fb16fe2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-16T08:22:32.9287357+00:00"
},
"company_sector_id": "931526b4-f44b-4858-bff8-999c88970b8d",
"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": "3f7bd607-b7a6-457d-b27b-4bf3ba1320c2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c5b3dfc3-44fb-4ace-8519-e42393271a3c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "90fe25f1-56db-4a27-80ef-28f2a2297bce",
"account_manager_user_code": "sample string 56",
"company_status_id": "193d9444-de68-4080-8a2d-c3bdaa5c8d1d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-16T08:22:32.9287357+00:00",
"id2": 60
},
"db_language_id": "3a21f651-514f-4bad-82c5-7886df493aa4",
"db_language_code": "sample string 7",
"db_title_id": "f4b44900-1708-43af-a1e6-27f03afeefa7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-16T08:22:32.9287357+00:00",
"create_date": "2026-11-16T08:22:32.9287357+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-11-16T08:22:32.9287357+00:00"
},
"modified_dateutc": "2026-11-16T08:22:32.9287357+00:00",
"id2": 22
}