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": "63a3ca45-d898-4a50-ae31-1b976becdaeb",
"_parent_id": "654d91bc-3156-4c87-9cba-6695bc550c5a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "97d59e93-750b-4e93-a7e6-d1929e099159",
"company_id": "1ab17ddc-aafb-404e-a8ac-f4c68a9f70b9",
"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": "ecfbc04a-b81a-4990-a002-aa4d5568c38c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "35691fc5-dff1-4900-847a-86694844f575",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "16ddbd61-b54d-42d1-af09-e752bce37b82",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c14af04-2118-46e4-9b6c-c39e30c36426",
"company_code": "sample string 5",
"company": {
"id": "769eada9-6feb-4630-9db9-d02d6d4b50ed",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-15T16:25:12.2819505+00:00",
"sales_territory_id": "10e8e9f9-9fed-4509-a6ff-a946aa3760a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0651b969-b8a4-4a99-a983-58f29ffa8775",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b91c157-e606-4459-9628-b87a9af01bba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f606f5b-a511-480e-a837-4e5a2ca4b1bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c0d0df3-5f2a-4cea-a23b-f885d4390cc1",
"db_currency_id": "fbf2288e-612d-42be-a59b-483373071376",
"db_language_id": "115581ce-2fa6-48de-8001-ba3e0648b6a2",
"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-11-15T16:25:12.2819505+00:00"
},
"modified_dateutc": "2025-11-15T16:25:12.2819505+00:00"
},
"marketing_segment_id": "395905a7-c78f-48b0-9de5-2893b71ac8dc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db9dcd92-f544-4edb-960c-b40e76d17c11",
"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": "bfe676dd-c149-4c0a-a567-8a8d2bd83d85",
"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": "25ae1ae1-8e31-4a11-b695-c55606cdb17d",
"db_country_code": "sample string 28",
"feelist_id": "315db967-65b7-453a-8330-6f7e72933b62",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "14b192b2-f2d2-46e3-a575-d29929c202c0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "07dd0b35-9fcc-4e78-bb00-c1be5bf7d495",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-15T16:25:12.2819505+00:00",
"db_currency_id": "e7cb3689-0f2f-4a59-9ed5-8bc2aad34468",
"db_currency_code": "sample string 10"
},
"company_type_id": "0404f3af-428b-46ba-8fd3-43f759ba9aff",
"company_type_name": "sample string 32",
"company_type": {
"id": "041468a5-e5b8-430c-a1d1-e86290d37191",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "557a91e1-c3f9-4532-b590-6b1cfe4ce940",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eb364ba4-76fe-4a99-bc1e-2d07e8509e87",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c003dbb-4a5c-4147-900f-f055585d14cd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "29107afc-d049-4e83-87a1-2c79c3dd1bf1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "09d6c334-0f96-4651-9f4e-0f90bf2aedf4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-15T16:25:12.2819505+00:00"
},
"company_sector_id": "80451955-c5ec-4e72-b9bb-ca70606293c3",
"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": "ae91576f-7c1d-4dcc-84aa-a3c90d54d7a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ae59637-5532-40a8-b778-d4d58cd43512",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b1f58042-535e-44ae-b7e4-4e38fb5524d2",
"account_manager_user_code": "sample string 56",
"company_status_id": "552fe251-0996-4ed7-aa36-cab401be229e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-15T16:25:12.2819505+00:00",
"id2": 60
},
"db_language_id": "6c1b548f-1ca9-4c61-8b9d-84a0b47b7824",
"db_language_code": "sample string 7",
"db_title_id": "9f7a8c5e-7326-4e4b-9831-cceb70442de2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-15T16:25:12.2819505+00:00",
"create_date": "2025-11-15T16:25:12.2819505+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-11-15T16:25:12.2819505+00:00"
},
"modified_dateutc": "2025-11-15T16:25:12.2819505+00:00",
"id2": 22
}