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": "012a0c6e-6ff5-4f7a-84e2-2b8730a3c4cb",
"_parent_id": "6d570728-b6b2-4bde-a934-488f8fa0283f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c6be4eae-1508-4687-a571-de81f44e33cc",
"company_id": "3cbc787e-ddf3-48f0-a498-d0032c693a30",
"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": "3ce0e80e-631e-4965-990b-fa4185a04f95",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "68b0e37b-de2d-4db4-ac76-1af4306d9a4e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0491d021-f70a-418e-a648-5c175881b8b5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "689f84a2-2c2b-4aee-bd31-de64e6533d92",
"company_code": "sample string 5",
"company": {
"id": "46439018-58fe-4337-a408-1f75a3e039d3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T09:07:01.663039+00:00",
"sales_territory_id": "f6c36bb3-cc60-4956-9747-59a79fc17e35",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ed41d8b2-7443-4c44-8d24-a408795bc061",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c65bbe61-59d5-4149-a9b2-03c42253cc24",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef0c0af2-c9ef-4c00-bb41-6f3d43c806f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaad48fc-1650-482c-937d-c0067f069ae5",
"db_currency_id": "44acc191-0b9f-491f-bcf2-d422a590d441",
"db_language_id": "c640d5be-3450-4e8a-8d28-37256a43a537",
"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-04-03T09:07:01.663039+00:00"
},
"modified_dateutc": "2025-04-03T09:07:01.663039+00:00"
},
"marketing_segment_id": "389ae500-a033-486a-ae85-4e1cba179529",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f9e2bb30-5153-469c-8973-3539e9018674",
"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": "196c47ea-94a5-4bd3-acca-482da81e403f",
"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": "6309acee-1240-4b37-a5ad-d85f038bce0f",
"db_country_code": "sample string 28",
"feelist_id": "40c9c526-81fb-4e57-ae6e-d700dc5510ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7ba25a9-7416-4d3d-853e-ae127f0b5a8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a120966b-f9b7-44e0-a95f-00eab10939e6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T09:07:01.663039+00:00",
"db_currency_id": "19a5368e-b1bb-47bc-b335-7e8136f3c4a6",
"db_currency_code": "sample string 10"
},
"company_type_id": "773b4432-1d0a-4297-9c04-24a5b0396bd8",
"company_type_name": "sample string 32",
"company_type": {
"id": "58a505ee-cdac-4fe3-b7dd-884b443a80b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cfeb35e8-2d1c-4531-a812-13df0360af6a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "08b2bc5a-c739-447b-a419-e4bcd18c0b6e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60cc4616-831c-47d3-9ca2-2c3f2c19ea02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8b0ae388-7840-43e1-9ea9-97831bdb02cd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a1a2740d-5f66-4913-8cf5-f9364449c1a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T09:07:01.663039+00:00"
},
"company_sector_id": "c9568ed4-85ad-4e24-9068-037b4b8893c3",
"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": "88631098-52b9-4046-8baa-7d73e3d677c0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f8040c1f-7683-462a-a0fc-cd8ee88a58ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f11a3aaf-22df-419a-8de6-c45b3b740a9b",
"account_manager_user_code": "sample string 56",
"company_status_id": "22eacfaf-6c2d-4bf6-8852-6012f74476d5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T09:07:01.663039+00:00",
"id2": 60
},
"db_language_id": "cd456233-8dc8-4825-a15a-4efb0760ed9b",
"db_language_code": "sample string 7",
"db_title_id": "29a5789a-91f3-4ea2-b349-7e489b101efc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T09:07:01.663039+00:00",
"create_date": "2025-04-03T09:07:01.663039+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-04-03T09:07:01.663039+00:00"
},
"modified_dateutc": "2025-04-03T09:07:01.663039+00:00",
"id2": 22
}