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": "141287bb-a416-498d-bdc9-b0035eb98241",
"_parent_id": "93b7aa6a-75de-4f20-94e0-07032686512e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "68023ed0-b4e5-4c18-b436-13d46346a3c5",
"company_id": "ee707925-b0cd-4a7f-bcbb-5c93b7cfce36",
"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": "49805418-6497-498e-a049-e3524e6c4fb9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "56615134-85b0-4805-9cd6-fbd474341cfa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "90a6733d-5e5e-4e2d-ae40-bf8bc4d1730a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e724b598-8af1-4945-8d81-5bdecd3fcf3d",
"company_code": "sample string 5",
"company": {
"id": "8da32acf-32c5-49e4-a253-eb2adf503878",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:43:58.5075+00:00",
"sales_territory_id": "4a84cbda-7257-4cd1-8265-da791a0af5ba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "32f4a627-de19-48b2-96c1-2b8e5db83889",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2ee7681-ffa6-4a07-bca2-7369fd01166a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f39f34cf-3e5f-4be7-b9a7-8ef101d4e646",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa7bcb66-6022-47c8-bcf2-ccf76d6293b3",
"db_currency_id": "d5a1d61d-b6bb-4ead-b044-599d54f16c8d",
"db_language_id": "5eb3ddf3-cd78-40c8-94d9-bdc0b3a99b58",
"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": "2025-08-12T12:43:58.5075+00:00"
},
"modified_dateutc": "2025-08-12T12:43:58.5075+00:00"
},
"marketing_segment_id": "bae1cfc5-ba54-442b-b590-e6da6084e103",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0f6fbab-6fdc-45fd-9860-4c5c7d2e56fe",
"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": "979ac11c-68fb-4f13-9e07-8ab95836dfda",
"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": "b38d794a-1ac9-4fc5-b58b-059ab13b40ad",
"db_country_code": "sample string 28",
"feelist_id": "3bc87939-cdec-4751-a20e-f9274c1c2f7b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b3f53ba9-384a-45c4-b362-204e11d3feae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3351d449-898d-4ee0-933f-eb6b11e35c0c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:43:58.5075+00:00",
"db_currency_id": "afcb84ab-f18f-4a5e-b73c-843522981176",
"db_currency_code": "sample string 10"
},
"company_type_id": "6fc97a55-d56d-4002-9e5c-1c6d1927e645",
"company_type_name": "sample string 32",
"company_type": {
"id": "75ce9bc7-c8b2-4356-9c87-a0f081794caf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e648a35a-59bd-4b6c-a28d-670ee09ad8d3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a75fa5e6-c139-46a6-a5c8-b4b173c6460e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2438bb33-d711-4ad8-9f9a-cd0611f144a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a2c6370f-69b1-4579-8eeb-75403c603591",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "05bf05fe-d662-48a4-89cf-dd64aaaeca09",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:43:58.5075+00:00"
},
"company_sector_id": "ca7ded33-14fd-42b0-8b0d-e80c3f286304",
"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": "14fb8fbe-9957-4f89-a61a-6476d5cf2721",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "144a5704-904f-4f0d-b9aa-fe3bf9451103",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5b79e63-c2c3-4a65-b7ed-dd440190e82b",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f5e959f-4d35-4dac-bed3-ccbc9e677e39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:43:58.5075+00:00",
"id2": 60
},
"db_language_id": "a6eba9aa-d2be-480e-b69f-5e7cf14fb3b2",
"db_language_code": "sample string 7",
"db_title_id": "042f8164-bee2-4dc3-990d-1df41391aa25",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:43:58.5075+00:00",
"create_date": "2025-08-12T12:43:58.5075+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": "2025-08-12T12:43:58.5075+00:00"
},
"modified_dateutc": "2025-08-12T12:43:58.5075+00:00",
"id2": 22
}