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": "229d2c73-6559-41e3-a650-aaf36f24a64b",
"_parent_id": "0695de22-f788-4dd4-9401-2c417f9f6178",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "090943a8-8cea-4a75-a00a-f8c48669e21b",
"company_id": "e59400f3-4404-4638-bfee-2d6347c35701",
"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": "b3e57e1e-f10b-4c40-a131-9550f36c6f04",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c0179609-4246-4057-9712-9bb5abfcd4ee",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b7acc0fb-9dad-4a40-adbb-59314385a38e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "69f13a28-f1bd-44f9-b6c0-fabc57cf8eb0",
"company_code": "sample string 5",
"company": {
"id": "bf7bd0ef-5a9b-461c-b6ee-d231c9760bab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T11:47:09.275556+00:00",
"sales_territory_id": "56406e2f-ac35-46c3-8456-2f94bfd8c746",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6c28878c-2662-4748-8f70-1bafa1e575db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "15190f6e-7677-4e1e-9265-1a88e3d2456c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d153e680-6564-44ba-9848-698db70e32dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d00546ab-0b53-46e3-bef8-77384beade22",
"db_currency_id": "b62d0490-0466-4d88-b8b4-0a0040156a32",
"db_language_id": "94b2f843-238c-4882-959f-10626fec1ef0",
"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-12-25T11:47:09.275556+00:00"
},
"modified_dateutc": "2025-12-25T11:47:09.275556+00:00"
},
"marketing_segment_id": "3687f7b8-55f8-4c23-874f-b25c21a0d150",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8f0036e1-f301-460a-bc2f-8c78bb35a38b",
"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": "3045434c-779b-44bd-8cf5-d9620e3550b6",
"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": "0607908f-2eba-46dc-825a-e349716753bb",
"db_country_code": "sample string 28",
"feelist_id": "76501b32-1564-4b83-ae17-834c30d166b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "db97a04f-c30f-4098-8dcf-da8aba256d57",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d4d4b85-0a2d-441c-ad99-9a125f925720",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T11:47:09.275556+00:00",
"db_currency_id": "005df0c5-e826-4f48-adf7-f9ca3e336734",
"db_currency_code": "sample string 10"
},
"company_type_id": "33413e1d-6169-4184-80f6-8b6ca41ec18f",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7c5a1c8-d696-4108-ad8e-c2b1635a67e2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bef7173d-7833-4625-b3a3-0def5f5bb6fa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4475e99e-65d7-4c1c-80a0-3e855475cc60",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3d12ad8f-281e-4634-87c5-3f5121770074",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e5068ac-0e30-4393-b37a-f3d8d7921fdb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96140705-188d-4767-a3f6-d1e6079619b3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T11:47:09.275556+00:00"
},
"company_sector_id": "90999f2d-fb67-4ce5-9399-7318a7541d15",
"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": "40058b04-de97-449c-be78-d87acccd50bc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d8ac0d8a-70a9-4253-94e9-deecaa3ce714",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "36b44b63-892f-48d5-beca-5e9b8c002dc0",
"account_manager_user_code": "sample string 56",
"company_status_id": "c348f69f-97e7-40c6-94a8-9a09b2378a39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T11:47:09.275556+00:00",
"id2": 60
},
"db_language_id": "80331efe-3ffb-45d6-a0b6-884f2e5a5783",
"db_language_code": "sample string 7",
"db_title_id": "262ca25e-1b7d-4b95-939c-13126bc3f95d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T11:47:09.275556+00:00",
"create_date": "2025-12-25T11:47:09.275556+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-12-25T11:47:09.275556+00:00"
},
"modified_dateutc": "2025-12-25T11:47:09.275556+00:00",
"id2": 22
}