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": "5628640e-6d89-4903-b1aa-71b13195513b",
"_parent_id": "c90a6bc2-3023-4767-ace5-8d1be0720ab0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a60220c0-e943-405e-a262-6306c40206e8",
"company_id": "c1da4584-bd58-4305-b33a-902f0c831a54",
"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": "e310eaed-450f-42e5-8fad-8c3b640eebc3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "963b80c2-c8f9-4f85-8839-4a106ef82e37",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ad7de9e5-4a26-4598-8b90-b5204d1f69ea",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "224e3c62-a689-4367-bce5-6e914d4c0e2e",
"company_code": "sample string 5",
"company": {
"id": "d79b7c71-ce8c-492e-b054-d46a42637fb3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T15:56:16.8475849+00:00",
"sales_territory_id": "e0258cdc-fa65-42f6-971d-b3285dd9a1a6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "463ba209-d130-4a0d-8c57-3ff3f22a7a23",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9affce15-3ded-487e-b18d-a5d9c5328fa0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47f294e4-dbb9-4743-9650-bd5e71b466ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c482d44c-4d97-4074-b908-e2d3edb0b11b",
"db_currency_id": "2f28708b-81d2-4fa1-adb8-1e0946d6b0ce",
"db_language_id": "bf956e7d-ff0d-4b7a-9bea-1eb21bfc029e",
"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-25T15:56:16.8475849+00:00"
},
"modified_dateutc": "2025-04-25T15:56:16.8475849+00:00"
},
"marketing_segment_id": "b66d5477-c864-437d-a381-d239ad1c9630",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0b3a9856-7a91-432c-aaf2-1cdf0ffa99d4",
"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": "bfa294e0-2985-48bc-bfeb-ba89aaf116e0",
"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": "91817beb-68d3-4dd7-94c5-0a46d6c5da6c",
"db_country_code": "sample string 28",
"feelist_id": "0410ea57-4a74-44d9-8f3d-2c4a43085f6f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c8d25bd5-15c3-47a8-897e-7826eb374524",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "043006b9-03af-45fb-b6a1-c95b25b04c63",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T15:56:16.8475849+00:00",
"db_currency_id": "73429e37-9393-4474-9982-5e894cfde51f",
"db_currency_code": "sample string 10"
},
"company_type_id": "ad3f3a47-778d-4680-9724-79133ea18bed",
"company_type_name": "sample string 32",
"company_type": {
"id": "4eba6157-5081-4074-ab54-ed00fd160c7e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af96409e-f562-47d6-89f6-344682297ffd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36b0a2b0-d451-477a-8e6a-111e528857ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e34aa56e-0399-4eee-a771-73ca8a674a74",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f5654a3c-974f-48c4-a1a5-c1bcc5f8d5a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2fa58e1e-0a38-4815-ae90-0c14ceee769f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T15:56:16.8475849+00:00"
},
"company_sector_id": "eb088bb6-e60a-4d4b-a7fd-777c177c0d24",
"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": "6886508c-c9d4-4a28-b393-4eb8d0562b98",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "de699f3a-4b83-4434-8a69-281ae79f8fda",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4fef935c-810e-4935-a674-3439430eb9dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "01acbc7c-6384-4201-99d1-8a6dd8fad704",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T15:56:16.8475849+00:00",
"id2": 60
},
"db_language_id": "59533808-57c9-4b6e-8503-1e16b47d5c9c",
"db_language_code": "sample string 7",
"db_title_id": "842ec8a5-7f58-405d-8423-ceb409cd594e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T15:56:16.8475849+00:00",
"create_date": "2025-04-25T15:56:16.8475849+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-25T15:56:16.8475849+00:00"
},
"modified_dateutc": "2025-04-25T15:56:16.8475849+00:00",
"id2": 22
}