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": "8ead56dc-2e0b-4597-990d-18e3e7231aa1",
"_parent_id": "adc6c2fd-e1b3-4251-a7b4-94ae3eac7431",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6379cc66-79a4-4039-a4b6-bf5e801fb8d0",
"company_id": "7627877d-0fd3-429d-8f6a-f09e08cf0acf",
"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": "84ac31f7-b29d-4fea-82e1-8c6979acb85e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8285a3b4-4221-407b-8d48-bb6395dffe54",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "78d6da56-1ece-45bd-ab38-d98cc367166b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "043e0315-6e1c-4abe-86cc-a43ea1f2827d",
"company_code": "sample string 5",
"company": {
"id": "528e31ac-d126-40e1-97a7-acc2d08e1f60",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T01:40:03.4434333+00:00",
"sales_territory_id": "1de6485f-483e-4c21-b4f5-e240068a07a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "598b315c-5721-4792-9277-86f270c3bf95",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "437e8039-403e-411c-893f-b6aa6d2cd983",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83bbe767-36f4-4bac-b17d-5f1deb781429",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "204c3661-4ffe-4133-b28f-51d1e51a7f65",
"db_currency_id": "e7ff167d-f1f0-4433-ab31-8959f6ac9af1",
"db_language_id": "9704f99c-ec39-45ed-9b83-41268f5b1918",
"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-08-29T01:40:03.4434333+00:00"
},
"modified_dateutc": "2026-08-29T01:40:03.4434333+00:00"
},
"marketing_segment_id": "39474534-aa59-48a2-8625-bcd4d4600439",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e487140c-69db-4d18-bc56-d9a13825f513",
"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": "e616c991-44bf-4fd0-9d59-78365a3149f7",
"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": "db968f76-5744-4eb6-b5e9-c1b33d98d744",
"db_country_code": "sample string 28",
"feelist_id": "7919b03a-3e57-4313-9287-e957f97f3a9d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "86186be6-78d9-4446-b9d7-85656e3dc5aa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "61b515f4-799c-4ab5-9e2d-2f70815cd012",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T01:40:03.4434333+00:00",
"db_currency_id": "fcac5c99-dfa5-4cd8-bd9b-95f26ad75342",
"db_currency_code": "sample string 10"
},
"company_type_id": "85f142d2-a952-4541-ac3e-d31ab897aebb",
"company_type_name": "sample string 32",
"company_type": {
"id": "f3ff41e8-4f56-4cc9-8e2e-fbf34db5c519",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "835c8759-df76-4c3a-bf21-a0fb8a8cb5d8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "986f6c97-d039-4432-8bd0-e0fcaaa7b2a8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0208ed78-a1c7-4456-949d-dd39252bb204",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f6f6711d-f8ab-498b-bc0f-56a0a85b01d5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83da85e8-c7aa-4ade-8d97-047e4ee068c2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T01:40:03.4434333+00:00"
},
"company_sector_id": "9cac89ff-b09f-4760-bef1-f6df45e16358",
"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": "874c82f8-ab3e-4208-8258-1e40de11a703",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2e8e74d5-cce5-4baf-aa4b-d1143d2055ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e515fc5-80a9-403a-8f42-af0e836e7fa5",
"account_manager_user_code": "sample string 56",
"company_status_id": "9092dd7b-1260-45ab-b5a3-143317259395",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T01:40:03.4434333+00:00",
"id2": 60
},
"db_language_id": "0a980657-a9dd-4bde-8276-4d570e3575a2",
"db_language_code": "sample string 7",
"db_title_id": "90ba636d-6104-4821-9cde-c0b7f87b4e0f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T01:40:03.4434333+00:00",
"create_date": "2026-08-29T01:40:03.4434333+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-08-29T01:40:03.4434333+00:00"
},
"modified_dateutc": "2026-08-29T01:40:03.4434333+00:00",
"id2": 22
}