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": "fdbb9b47-e263-4454-b2da-3732a1105b35",
"_parent_id": "cfd3c338-0f8e-4e51-9662-471ca4e1468d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b3c95973-c8b9-470b-9f12-9a930a1602b3",
"company_id": "aeb467c9-1972-4419-a820-c5e9a8d32ec6",
"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": "b42f03ec-42d2-462a-8a4c-905b4ebbbf6d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "80cfdab6-086d-49a7-bac8-95261274c80d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7dfbd362-a621-4fdf-a20d-f1b4cf44f81b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ba002f88-7470-4aae-bd3c-59aa33316ff3",
"company_code": "sample string 5",
"company": {
"id": "fef5a6a1-e464-4027-ae3f-6b8eea359748",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-10T13:10:24.5052131+00:00",
"sales_territory_id": "d3d2f80d-1a97-4b00-8bc5-d2955dabf94c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5bb3e60-b7ec-491f-93bd-947eb14dd505",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab3fc251-53c1-4d23-ad83-eaf1ddee084d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c622e215-8ef7-48be-849e-7e4015dacc53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9636abd-4055-43d5-a9da-c6e9f132317c",
"db_currency_id": "34319f62-73fe-41a0-959a-dd0ec9567aed",
"db_language_id": "68078cc3-e8cb-4207-b06a-381445945ae8",
"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-11-10T13:10:24.5052131+00:00"
},
"modified_dateutc": "2026-11-10T13:10:24.5052131+00:00"
},
"marketing_segment_id": "043a5288-28ff-4c86-8b68-e4f276152c81",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b6055d1a-6857-4d01-b3bf-b439b59f9e86",
"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": "ca574ed1-f53a-4228-9c76-a1e1d82475f2",
"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": "d00cacaa-d845-425d-a5cc-8ddfab3371c8",
"db_country_code": "sample string 28",
"feelist_id": "1d8f20cc-dd02-4416-b55b-72720971b168",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "aaf964bb-c01a-4ba8-a2e5-5991481f4d24",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f021555d-12a9-4a9b-8218-fa736ad57bde",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-10T13:10:24.5052131+00:00",
"db_currency_id": "da5dc01a-f37b-41dd-ade7-756b21034282",
"db_currency_code": "sample string 10"
},
"company_type_id": "a0853794-9dcb-4949-9a19-742be6c94185",
"company_type_name": "sample string 32",
"company_type": {
"id": "9e46d1c7-8040-419f-a42d-3be73d93f355",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3657ec30-9bc6-4231-9390-4a24eeafcafb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f842f03b-c530-48da-a0a0-48a0bd76d1a9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c965fbb2-a2e8-4101-977c-7266b1157fd9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7104a6a1-9df5-41ce-953f-81bdbe7fedab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bdd0c1c0-c210-4dd3-b74b-33bb462f14cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-10T13:10:24.5052131+00:00"
},
"company_sector_id": "63fb2db1-ce12-4ec6-97a1-50bd907c6826",
"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": "8f3b0e92-c63e-47bc-b173-18e6d8366140",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a326f12a-67ef-419a-8525-69131701b239",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "32d2dd16-367e-487c-b061-1303aaf7cd0a",
"account_manager_user_code": "sample string 56",
"company_status_id": "7b335021-212b-4bf2-99c6-59db91873c45",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-10T13:10:24.5052131+00:00",
"id2": 60
},
"db_language_id": "a490bf6a-fc83-43d5-b16f-e938ee860a15",
"db_language_code": "sample string 7",
"db_title_id": "5d3ccccc-eb5e-4ac7-b08e-4d75f7fa132a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-10T13:10:24.5052131+00:00",
"create_date": "2026-11-10T13:10:24.5052131+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-11-10T13:10:24.5052131+00:00"
},
"modified_dateutc": "2026-11-10T13:10:24.5052131+00:00",
"id2": 22
}