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": "f9237a30-150d-4318-8517-7745ef736062",
"_parent_id": "d4fce91b-f0e8-43fc-8189-b3e80bb30a46",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3849ead8-b20c-4760-94a8-892ce7f44771",
"company_id": "2d40386e-a1f5-494f-96f6-6525dc262206",
"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": "01cc114e-8e75-448e-9988-17e37b434174",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ff60d37f-3c8f-489a-96d4-536f5854e981",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f3c96723-9a21-4bde-8cad-ee3e30781494",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df8290d3-f29e-43d6-8a69-25abc3e915b8",
"company_code": "sample string 5",
"company": {
"id": "dd8d23c4-b4d4-44f3-a93a-3c3d61d34ee7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-11T12:40:22.8649824+00:00",
"sales_territory_id": "01043fad-af57-4eb4-82b8-221d10c6678d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dc6b61ba-1eb0-4cfa-b47f-155f2227518b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d9a6d19-bbb4-4a98-abb9-cdc70244e42a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a96c628-cddd-4768-8f90-e6d2385711e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "731bbf79-60ef-4b53-a084-8bd9254535da",
"db_currency_id": "8e696e9a-4689-41e2-9d04-4008ba58e234",
"db_language_id": "6da31e19-a21f-44a3-a871-f57afc3745ef",
"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-12-11T12:40:22.8835727+00:00"
},
"modified_dateutc": "2025-12-11T12:40:22.8835727+00:00"
},
"marketing_segment_id": "e7b5f847-70fb-4790-bb32-bf6ed42c8b07",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f942dbcf-c931-42c3-b3e2-05bec75b8017",
"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": "9f4d5809-a788-476b-88c6-11fce9b950cb",
"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": "fb294069-feb9-4fb6-bcd1-62adb1ae0b1e",
"db_country_code": "sample string 28",
"feelist_id": "e6917f02-0e43-4053-81aa-f8b5015bb7c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "883456f8-d276-4f23-8d79-a6829283d4b3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b6da78ad-2abb-4d48-bde4-7418d3196f2b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-11T12:40:22.8835727+00:00",
"db_currency_id": "aa2af6c7-1a52-4363-a6a5-e1c63e84b235",
"db_currency_code": "sample string 10"
},
"company_type_id": "4bb60fdd-c327-495b-884c-4725be9436f8",
"company_type_name": "sample string 32",
"company_type": {
"id": "928aaa92-0dfa-43c7-a6b9-8447269eaf09",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "235f4887-db50-4d4b-b4f4-b0f3569a8f7a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c3df344b-d12a-4b3b-a75c-c8a51dd2a217",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aed87d06-ee45-4617-8bd1-48f4eb2e1433",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b8e87b5c-76c5-42ce-9081-17cdc0659de7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "42dbbbe1-a68c-4e84-b45b-f385e1182fcb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-11T12:40:22.8835727+00:00"
},
"company_sector_id": "8b287f1a-599c-4243-abd0-a3009e0c24bf",
"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": "c0a02238-e227-485c-9273-3ea1c8c7cb8b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0ae2251-ee7a-485c-ad2a-dcd12ab10872",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db42f28c-e1dc-4ff8-b9ea-fd49e6d54002",
"account_manager_user_code": "sample string 56",
"company_status_id": "18be23ed-e0cd-48c8-b291-8bc954366a5d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-11T12:40:22.8835727+00:00",
"id2": 60
},
"db_language_id": "4d1dc948-033f-4111-b236-7555011c7cb1",
"db_language_code": "sample string 7",
"db_title_id": "10a23e4c-1428-4ea5-8b5a-465d06513c53",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-11T12:40:22.8835727+00:00",
"create_date": "2025-12-11T12:40:22.8835727+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-12-11T12:40:22.8835727+00:00"
},
"modified_dateutc": "2025-12-11T12:40:22.8835727+00:00",
"id2": 22
}