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": "03fe64be-4618-4ed0-9423-09af14cbb2c1",
"_parent_id": "758a0053-7428-4c62-bcd3-a89ac7d684c0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1ae42edc-7bfb-4eb2-8d45-1705ee9354cf",
"company_id": "85ad125e-5b7d-4708-be91-aedba61ea934",
"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": "191586a8-907b-4e8f-b30c-a4a420d48beb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "92ed6c4a-9b49-46eb-9922-cf097b1409bc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "839c058b-9410-466b-9b6c-bd59e3fd210e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "89ff707e-ec85-4399-84f2-23b5972dbab7",
"company_code": "sample string 5",
"company": {
"id": "5e64111b-3456-4282-b972-e9cddfa41ff4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-19T00:03:36.025367+00:00",
"sales_territory_id": "a59253ff-c159-40e3-9790-0e9792b50607",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ef88a765-6386-4017-97e9-a584455bf914",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57792160-6fc5-43f9-be13-5d2ca40b2168",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d541d9b-ba94-4ee1-aaba-8a4d1113a9e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b8692e5-8662-44af-874d-d6d9ee708115",
"db_currency_id": "959be971-5ec6-4e23-b124-d44c65bd2f3c",
"db_language_id": "da9b541b-add1-4d95-80cb-628be8394a40",
"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-07-19T00:03:36.025367+00:00"
},
"modified_dateutc": "2025-07-19T00:03:36.025367+00:00"
},
"marketing_segment_id": "02446553-f603-43df-aae9-7643f7de67d8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cada027c-fff4-4d19-a8c4-08794e708443",
"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": "fcda4187-5040-4bbf-9054-69a79371c4dc",
"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": "51bcfeb2-96a1-470e-b27f-1f3d133bbf62",
"db_country_code": "sample string 28",
"feelist_id": "fecfea5a-3f24-4094-803c-843941880cf0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2288d3d4-af64-4413-ad92-1890e94b4f9b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6cda8cd-38f5-469e-8ae4-95fc28bd791a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-19T00:03:36.025367+00:00",
"db_currency_id": "c94687b8-1e3e-4877-bccc-f415e4f3b8f5",
"db_currency_code": "sample string 10"
},
"company_type_id": "806fe303-3df3-4b4f-b40f-9c702bee5c32",
"company_type_name": "sample string 32",
"company_type": {
"id": "7aef54dc-b7f5-4c92-9ba7-f91cc9624634",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7ff4801-9cff-48c3-b49a-d2eeb4d58d87",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e44fd2aa-47b5-454d-8ddc-0dd8fc3334f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b2a206d-1b79-4877-8efd-4c18244ef94d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3691f0e-fc9b-4176-846c-00c0bc5087dc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d42e9ee-1ed3-41b5-bb51-e6dbb4ca1630",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-19T00:03:36.0412873+00:00"
},
"company_sector_id": "23f4b54b-8406-45c1-acfd-ddc4973e1f40",
"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": "4cf2e467-8616-4d27-a8cc-1698781642e4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d3de0721-64a1-4370-8ab4-301af9143997",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "17fe455e-9133-4546-9b1a-facc0df616c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "c63d324f-3628-47d3-85cb-37b8de38ca46",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-19T00:03:36.0412873+00:00",
"id2": 60
},
"db_language_id": "59c1544f-837f-4c30-84a3-a6c886706b24",
"db_language_code": "sample string 7",
"db_title_id": "ae30bb86-a54d-48e5-b7ed-7db8791bd980",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-19T00:03:36.0412873+00:00",
"create_date": "2025-07-19T00:03:36.0412873+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-07-19T00:03:36.0412873+00:00"
},
"modified_dateutc": "2025-07-19T00:03:36.0412873+00:00",
"id2": 22
}