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": "bf798101-8960-464c-aac0-cda48a1f31fe",
"_parent_id": "b779afc3-0293-4d68-b65f-dd137bc65b39",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "04708524-ca7b-47bc-b13d-a00e9b126bd6",
"company_id": "9f484895-70c5-4c0b-b5f8-a7663398e508",
"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": "5d96ba56-be6d-4b21-9a84-7366d52994a4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bb63cb3e-b3fe-4934-84e8-cf6a389c07c9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "52e697f0-0d5f-4a5e-8189-c4b18c03c385",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c0c808c3-d43e-403f-9625-4699a7e9e168",
"company_code": "sample string 5",
"company": {
"id": "50698836-9a40-40b1-b73d-4cfb3ad7a32f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-30T01:39:24.4182012+00:00",
"sales_territory_id": "9fb0bfa7-5baf-4cfc-a090-c8fdc993bf2f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4df7a2a-6caf-4ffd-9e4c-333ad9acd9e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "838a2a13-39bb-4c54-99ed-b076cd3e8a46",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e6c0982-98d2-4b02-9a4c-7147ef944b8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50c65d53-0243-4644-b591-efd75d3df95b",
"db_currency_id": "d9f30f0e-4aa4-4264-85be-e6938f0c1a8b",
"db_language_id": "ef8b8eb0-290f-4b27-968a-5b748cab8cb9",
"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-01-30T01:39:24.4338385+00:00"
},
"modified_dateutc": "2026-01-30T01:39:24.4338385+00:00"
},
"marketing_segment_id": "e2c36534-59b5-4206-9108-432b9d27c368",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df5338bd-e072-41c6-9502-b70535e02469",
"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": "23a4239d-b405-493b-93f7-2039ec3d2cac",
"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": "6934932e-790f-4842-81e8-9ede2897304b",
"db_country_code": "sample string 28",
"feelist_id": "6cb92c2b-5ab1-45f4-952b-69b525708020",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "366f1ec2-03eb-4a31-b08e-9f423c96f204",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "06c89ec4-7cc9-4061-b55e-75f6f3a8c712",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-30T01:39:24.4338385+00:00",
"db_currency_id": "e36befb7-5c44-48cd-afb0-5f8b67e239f5",
"db_currency_code": "sample string 10"
},
"company_type_id": "eb660796-a9f5-4017-b95c-3db5d2a2c75e",
"company_type_name": "sample string 32",
"company_type": {
"id": "f2b1e4e6-8160-4860-a5a9-959ec4c123c7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b284fc9-2e58-4c92-a9f3-92e2e6a68885",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c2887c11-af7f-407a-a9ef-aaf2a0093558",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "49156bd0-91d9-4020-a00f-925836fda9a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c65224bd-4e34-4d98-b094-004a7398b792",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7d33434d-5f89-4a00-91e8-9d51a6626022",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-30T01:39:24.4338385+00:00"
},
"company_sector_id": "21b7d98f-97b9-4f7d-8d4e-f777f19d4ddb",
"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": "95d4af86-7826-494b-bbcb-e247e066d8a1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5fca47e1-ca78-491d-a2ca-ac464d94eae7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "49242751-cb15-4a40-a4d4-338a53ba6de2",
"account_manager_user_code": "sample string 56",
"company_status_id": "7402361a-59e6-4898-895b-fe71bda6ad7d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-30T01:39:24.4338385+00:00",
"id2": 60
},
"db_language_id": "3b456495-1cd9-411a-b602-5356d35d5b54",
"db_language_code": "sample string 7",
"db_title_id": "d828c463-a6ef-4342-9b05-e87d46fbe672",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-30T01:39:24.4338385+00:00",
"create_date": "2026-01-30T01:39:24.4338385+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-01-30T01:39:24.4338385+00:00"
},
"modified_dateutc": "2026-01-30T01:39:24.4338385+00:00",
"id2": 22
}