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": "48176885-7880-4e2a-8cbd-b4309a2a3ef6",
"_parent_id": "c4a0380b-7f04-4e05-97b9-76f92b867595",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "29f59a1f-ee28-490c-bf23-8cafd6b90a34",
"company_id": "5a35bd37-8faf-4a6f-9202-894ef7aae84b",
"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": "123b2be1-20c3-487f-a529-538bcf3684e4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "608ba71a-722a-48aa-9c69-ebeb572a600c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ca759973-a065-466c-8866-c74b4f6e13a7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "17fdb9be-2b92-4f9f-8c5d-0220c0e71078",
"company_code": "sample string 5",
"company": {
"id": "1a3b9e08-ec5c-45cb-b3f8-201e5f6028ce",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T05:22:47.837666+00:00",
"sales_territory_id": "f6661f87-5b73-4fa7-aef7-08102232035d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1a893b33-f6f5-4bc0-b221-494206e8ba0c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "196417c7-6853-480b-9261-359e2a9df26a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "68b4f9b7-2ffa-4188-a07e-738a9a9edd26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecc6d6dc-8f6a-4255-9a5b-47f0973f6927",
"db_currency_id": "bf795f31-ccec-4bf4-8754-41ad2009d1c6",
"db_language_id": "aac6d673-9d6d-4c4d-b54d-b48260b936f4",
"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:22:47.837666+00:00"
},
"modified_dateutc": "2026-09-09T05:22:47.837666+00:00"
},
"marketing_segment_id": "4c4f4eb3-f1cd-4e71-b0da-99d41fb010e4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e801df55-82c1-4cec-aa0e-0e9cc56ca7ff",
"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": "230bf527-b55a-4aa4-9d1a-1d60a6aece99",
"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": "6a465fb3-c9a4-45ba-8be6-d95439f20ffb",
"db_country_code": "sample string 28",
"feelist_id": "fee19de1-0769-4691-ae9a-52a35027a294",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be31caad-5c5f-4a73-ad82-8a523852b5a6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0f1c9f00-4d5b-4ad2-b394-834b1d7f3fd8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T05:22:47.837666+00:00",
"db_currency_id": "6373a483-a137-479e-bf58-1d3fa7a2b984",
"db_currency_code": "sample string 10"
},
"company_type_id": "d879cc48-16cb-4b2d-8e49-e11abfde3ef5",
"company_type_name": "sample string 32",
"company_type": {
"id": "803d92e7-04a7-4603-a3fb-51abfbfc41d7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c40ca8e8-1632-44dd-9f90-ce5cd04dfbdf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c317ffcd-352a-412f-b062-0c1c2d82b421",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0d7ccb0f-cb02-49d2-97b6-9f9f536b096a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "82341b46-1e4a-492c-a1f4-ca90f3a4e79c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "012bcce7-de56-4a01-8c1b-2840652199eb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T05:22:47.837666+00:00"
},
"company_sector_id": "34255788-e6e5-4046-bf48-f3d1c460bf34",
"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": "652a7840-1960-4346-8b01-8488ef8cdb0a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6e8a4473-723c-4760-ab81-c3f07b479205",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "052611ea-0b77-4adf-82de-af888b7c76c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "4b44c78f-cfca-4fa0-b6b7-046d7dcc83e4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T05:22:47.837666+00:00",
"id2": 60
},
"db_language_id": "9cb6f042-02ce-41d6-aa02-e6000936cd40",
"db_language_code": "sample string 7",
"db_title_id": "13881aa8-5ed2-4787-9aa6-87b0d36afd15",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T05:22:47.837666+00:00",
"create_date": "2026-09-09T05:22:47.837666+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:22:47.837666+00:00"
},
"modified_dateutc": "2026-09-09T05:22:47.837666+00:00",
"id2": 22
}