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": "7de4cf20-4430-4ca5-8a26-d678c8b6aaa0",
"_parent_id": "8edb3c5c-3d13-4542-8dc5-d9223ffbc1bd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "57d56d7f-3ace-4bd0-981e-f84d4ecfc911",
"company_id": "389b52a7-6e26-474f-99bf-374185569e37",
"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": "a82a7150-ea6f-44d5-8882-4ab6ccedee10",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2929849c-2ce1-4894-ae45-93ba8554a703",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cdaa737c-5a0e-421f-8f92-f8ae245cf236",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a19333be-c4c8-486f-a113-1fd95cd3c24d",
"company_code": "sample string 5",
"company": {
"id": "749dc1b2-89f8-4429-a30f-c1d2ea903ea1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-29T03:35:32.7421567+00:00",
"sales_territory_id": "d4b05d6e-4c5e-403a-abb1-c818dc26933e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "42aa645c-ee48-411b-acd6-508980088414",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d23bd1ac-b979-4b36-a41a-259fd1a3a4ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0cfd1b37-46d2-4b5b-bab5-7048f978d701",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf3051cc-54d9-4000-9de8-726b721cc241",
"db_currency_id": "6d527835-3fd7-48d6-8b97-7d6baab13e08",
"db_language_id": "bbc6a209-2983-4512-b729-2caebba17885",
"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-03-29T03:35:32.7421567+00:00"
},
"modified_dateutc": "2026-03-29T03:35:32.7421567+00:00"
},
"marketing_segment_id": "65ad1ff2-5a05-4a36-abc0-0996d7790c00",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ae742370-c762-42f4-bb71-503c69bfb212",
"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": "64a19d47-198a-49e5-a5b3-8ad091e6ccb1",
"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": "be996faa-8fb9-4e03-8e31-9dd7daf63acf",
"db_country_code": "sample string 28",
"feelist_id": "9fd3bb8e-ac83-48e2-8010-fb5a7d481965",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5ffe2e8b-a2f1-42af-8e6b-b72369583086",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b5e7544-9131-463c-bdfe-8902af2400a8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-29T03:35:32.7421567+00:00",
"db_currency_id": "f5cbffb0-127a-48e0-ab34-cc96b5d15386",
"db_currency_code": "sample string 10"
},
"company_type_id": "ad91fa84-a61e-4928-bca8-245e37a9d83f",
"company_type_name": "sample string 32",
"company_type": {
"id": "a9150d66-50bd-4953-880b-11f8507661da",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2e1cced-d4e0-4c90-8356-879f8611d7f5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7516f196-94ee-4a46-a0c0-71da940b4241",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29ea096a-4136-4084-bb89-c30c39a2b038",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c44c314-3fc4-4fa3-80fd-e7dbc0049f70",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fc56332c-bd24-4809-8dce-9ee7f29e0445",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-29T03:35:32.7421567+00:00"
},
"company_sector_id": "8eee4852-033c-49b7-bd22-e6fd8262e395",
"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": "da4f3efa-94d9-4f9b-ba44-825f6ecc45f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9928f131-3ff5-490d-9dd7-2601e4fc489f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87cb4bff-95ab-4cb2-b404-b5f3dff94077",
"account_manager_user_code": "sample string 56",
"company_status_id": "0b057ece-d370-46a6-a475-1c042ca5c4e4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-29T03:35:32.7421567+00:00",
"id2": 60
},
"db_language_id": "515ce092-b7ef-4696-b23b-5f25c18732d3",
"db_language_code": "sample string 7",
"db_title_id": "5766bcbe-b46d-4f54-a22d-e6a6499b116f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-29T03:35:32.7421567+00:00",
"create_date": "2026-03-29T03:35:32.7421567+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-03-29T03:35:32.7421567+00:00"
},
"modified_dateutc": "2026-03-29T03:35:32.7421567+00:00",
"id2": 22
}