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": "37b2f81d-e534-4db3-b7b3-7a08897d184b",
"_parent_id": "582cef7e-7489-4184-b1c7-ae759059ded7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "52bcb4af-06f5-4e60-af92-279bb2ca9d36",
"company_id": "67a647fb-4855-4e29-ad20-7c660a305aa0",
"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": "0b290b24-d2cf-488a-8e86-f88362ab27dc",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5df1fe17-a5b0-4f16-a100-2e83c9ed8e11",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dc06d314-7041-4aa6-980b-7ab9fe161c38",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7178fdcf-6438-4ca2-9c49-6d63347ddc79",
"company_code": "sample string 5",
"company": {
"id": "223b2e62-3ac0-425a-9929-550d1ecf29d9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T05:46:30.1569278+00:00",
"sales_territory_id": "254fd100-f6b1-42eb-8ba2-6af0e60baba8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "690c8c3f-ccca-4ced-94dc-bd01b641283f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5864efc0-ffc6-461d-887a-a4ce5acb664c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f20f9d4a-6c9a-46e2-8808-b63510f297cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7cf67b83-c304-44d6-83a7-0ead371cb524",
"db_currency_id": "e1d105be-efd8-46c8-8cef-5a6758b38781",
"db_language_id": "73c7e0d2-3802-4019-8be4-82fcf73b8db5",
"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-08-12T05:46:30.1569278+00:00"
},
"modified_dateutc": "2025-08-12T05:46:30.1569278+00:00"
},
"marketing_segment_id": "1a1b4b6e-a90f-4390-8e73-a7b15af17cc6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d1a26fe-56b4-4b27-a028-555eb46e68d9",
"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": "8c7ec93c-2c55-4415-9b95-bd2a555eebca",
"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": "762a52f1-8a6f-4eb7-a0ff-d1a7548a74cb",
"db_country_code": "sample string 28",
"feelist_id": "3c619dd3-e84e-407d-9b59-c03a2a5a491b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5743d380-892c-4baf-8e91-4c5523f31bfb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64920461-3c7d-4c71-af5f-909b2fbc2f3f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T05:46:30.1569278+00:00",
"db_currency_id": "564e222d-c71c-42ab-98c6-f0b05c64cc14",
"db_currency_code": "sample string 10"
},
"company_type_id": "6eb57349-8678-4029-b0a7-769707bc21fb",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d2cbc4e-8c92-4d1b-afc5-f0753b371c3a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63956287-8eec-49e0-aeed-8a3fe0072db9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "98981bad-14b8-40f4-82c9-76507bee8ee3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2ea7a975-c685-4b2b-8ab5-d3dc1c926c77",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "398caf8b-0842-44ab-9af9-071f142e0cd9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e56de81a-8005-405e-b4a2-d36b4cc044e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T05:46:30.1569278+00:00"
},
"company_sector_id": "080818ef-81e0-4f21-84ae-3a330fec8225",
"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": "e4734856-b221-4ee9-9905-dbb876bfd9a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "598e0f99-90bc-4d31-ae0a-6095195833e4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a3103221-42bb-47e8-885c-e5fd0bafc5e1",
"account_manager_user_code": "sample string 56",
"company_status_id": "76ddbbf3-b9d5-4f81-9729-928f6bbd25ba",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T05:46:30.1569278+00:00",
"id2": 60
},
"db_language_id": "5968957a-83eb-45a9-bbd9-e2cbf7a5730a",
"db_language_code": "sample string 7",
"db_title_id": "4583b641-1458-4944-949a-68b8bd278822",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T05:46:30.1569278+00:00",
"create_date": "2025-08-12T05:46:30.1569278+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-08-12T05:46:30.1569278+00:00"
},
"modified_dateutc": "2025-08-12T05:46:30.1569278+00:00",
"id2": 22
}