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": "209e5bce-b51b-4589-bc9e-42fc814c03ca",
"_parent_id": "5a1ba9cf-18d7-46a7-9ee5-9b0435b3ea39",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2b9b6d42-b095-4408-9069-21324077f777",
"company_id": "8ba76a89-28b4-4984-9c09-ed86a4689959",
"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": "accc1dd6-5481-4282-99be-139a9b0b82b7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "922abab4-228e-4b0e-a147-37109a22f0fa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a2371561-e64f-4991-881b-5caa1f488c78",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "94a446e0-f786-486e-94e0-494f75e60006",
"company_code": "sample string 5",
"company": {
"id": "99c2cb9c-a251-4096-9c0b-cdd67298e8fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-24T13:52:37.2981173+00:00",
"sales_territory_id": "5c51e193-2fbf-4f24-95e4-671b8abe30b3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c9ac155-b9d0-4f22-bbd2-ee2eba55cafb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c373d449-b224-477c-a4b9-58999d0bed0e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d75e3018-e7d2-44d4-b667-94e8c8ce1a2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca113e42-9a6a-4a5c-8f16-770a21f61fd5",
"db_currency_id": "8eafd273-3574-4eba-a0ef-bea6a9a8d47e",
"db_language_id": "d7159a4d-2dbe-4a39-9b26-b3cae232e725",
"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-02-24T13:52:37.2981173+00:00"
},
"modified_dateutc": "2026-02-24T13:52:37.2981173+00:00"
},
"marketing_segment_id": "b620933b-a6b2-4355-871d-7dd5a0013e74",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "331ff8e4-25cb-4405-bfdd-fd79f0702d0e",
"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": "d94bd393-83c4-4097-8581-69fd60f8538e",
"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": "55fe43c1-a905-4152-9431-ad94bb7ab04a",
"db_country_code": "sample string 28",
"feelist_id": "e37243f9-856b-468c-8343-430e32b08a81",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3c73f6a9-6d49-474c-ab16-bde70742b03f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "68e865d4-5ab0-464e-baae-1d013eae2af3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-24T13:52:37.2981173+00:00",
"db_currency_id": "ba6ec591-53a0-4188-b96a-6aa4f8960c01",
"db_currency_code": "sample string 10"
},
"company_type_id": "86cc0537-c69a-4979-ae28-7d2fdbbb9f95",
"company_type_name": "sample string 32",
"company_type": {
"id": "6f30a98d-6797-4a54-a64a-dbf9f0c8d5fb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9eb561df-f061-478b-af76-b20a084be4af",
"sales_organization_code": "sample string 5"
},
"db_language_id": "57d0cfd5-4b3c-48ec-a35a-a94ea7b6fe11",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "668238fd-20c3-4b8e-a364-f118e0c3e0e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c416fbf-0489-4042-ac99-39539dc51792",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d8a5c86-2510-4ca1-9fec-395d5a721714",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-24T13:52:37.2981173+00:00"
},
"company_sector_id": "4c6893cb-8b31-4b8d-ba18-4863bf27730e",
"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": "b46f05ae-e6e6-4f87-8e0b-20b87336b9a2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "93099637-3205-4abe-bd8a-5c0f7c85e31b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d8368a73-35dd-4ead-ae5d-3288e3159bdc",
"account_manager_user_code": "sample string 56",
"company_status_id": "12d37b6e-d7e1-44a8-9206-bacb6ed8b35b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-24T13:52:37.2981173+00:00",
"id2": 60
},
"db_language_id": "624ff2a8-4793-4ba8-92ee-e9d749de1293",
"db_language_code": "sample string 7",
"db_title_id": "f4c23cee-96c1-43a9-b98d-8154aaa2ca18",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-24T13:52:37.2981173+00:00",
"create_date": "2026-02-24T13:52:37.2981173+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-02-24T13:52:37.2981173+00:00"
},
"modified_dateutc": "2026-02-24T13:52:37.2981173+00:00",
"id2": 22
}