Retrieves all the locations
Request Information
URI Parameters :
None.
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": "5ab94702-c708-4321-b09d-d210d3dcc0e4",
"_parent_id": "d46f70f5-7402-4cf1-bf9c-4d533c3d2b86",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b7e70be-f2a9-46c5-8ea6-c800768c4668",
"company_id": "b63c5b56-58ec-4dd8-80fe-0ae28c3c59ca",
"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": "7664adf9-f492-4837-ba90-f8fff1fef415",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "03609d74-a359-4022-a6e9-6f17eee5effd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2c8db26b-f759-4988-b7e1-ed1b81982284",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "43d74040-adb8-44b1-89a0-e7bf5af460a1",
"company_code": "sample string 5",
"company": {
"id": "500d439e-3007-4932-a7c7-3b71d8f0725a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T21:21:28.0651246+00:00",
"sales_territory_id": "165cdf24-26b4-4fb7-ac5c-b5f11ecc5260",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b8fdb7ee-9b99-4c58-ab28-c0c77acaae81",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "816d6523-5d84-4f59-9587-9b894a21c97c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d585b9d6-6b38-41be-ba03-c1950efaddf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c02f2cf0-9714-472a-b75b-343b27c2ce5c",
"db_currency_id": "90c7d264-c176-428d-9c9e-c33ab7ea80b5",
"db_language_id": "01691590-3eae-4eea-8b5a-aee1a20eaf23",
"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-03-31T21:21:28.0651246+00:00"
},
"modified_dateutc": "2025-03-31T21:21:28.0651246+00:00"
},
"marketing_segment_id": "ddda389d-0d04-4411-84aa-3e16ef601556",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3188f4ab-0335-446b-9118-576f19129dca",
"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": "c70f7bd2-2229-4b88-8dc1-63b958bd5e41",
"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": "927764a2-0ef1-407a-8a8e-7fd14eb2c8c0",
"db_country_code": "sample string 28",
"feelist_id": "1a708240-3c3c-42f2-8ca1-628f42ec091b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "837fc29b-e812-41f8-b9db-b6abb53801ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5cbb6ffa-2f6f-4c94-8cbf-90024ceacc9f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T21:21:28.0651246+00:00",
"db_currency_id": "dd4da7d4-5c60-449b-a919-61591c39c1ef",
"db_currency_code": "sample string 10"
},
"company_type_id": "7ba86f85-02be-4962-b901-76319fd8741c",
"company_type_name": "sample string 32",
"company_type": {
"id": "75f19afe-ae4a-4dc2-85e8-0f80352ed3b1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "564a0d81-56a2-41a6-933b-ae345f19373a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1367381e-6d5d-4fa2-97c7-5009dfa16442",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "af3b3c91-1c9b-4ab0-8a9a-44611e15b9b9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "935fa655-c6c7-4f3f-9fa3-6a87e95d660a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0cbb2cc6-d062-4c96-a62a-6c3b7f586a2e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T21:21:28.0807556+00:00"
},
"company_sector_id": "26c93a6f-eb00-4e01-a2c9-1fa3a2bea59b",
"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": "8af4a45e-e82e-4684-b1a7-0a567cbff6fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d51373c-c4a6-48ad-8a39-964ad8a44850",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "44613e2b-84d5-45c3-b46d-c6e2af84881e",
"account_manager_user_code": "sample string 56",
"company_status_id": "07450cdb-1b9a-4721-986c-f5e7c0b13c51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T21:21:28.0807556+00:00",
"id2": 60
},
"db_language_id": "886985ef-f371-4398-af8c-c6b936d6182f",
"db_language_code": "sample string 7",
"db_title_id": "c8499a8a-cc75-45c2-9d6b-a83ee65d39af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T21:21:28.0807556+00:00",
"create_date": "2025-03-31T21:21:28.0807556+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-03-31T21:21:28.0807556+00:00"
},
"modified_dateutc": "2025-03-31T21:21:28.0807556+00:00",
"id2": 22
}