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": "b3fd05e7-d36e-442b-9124-8e0722d102a2",
"_parent_id": "cdbd7e08-6f98-4696-b0f1-2572dcc39caa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5318f646-720e-4be4-92dc-74ca6ef41fac",
"company_id": "927595bd-748c-450e-9e00-8020d45ff448",
"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": "42571add-08ec-4e5f-9476-17a31ddcd037",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "165dbea7-8aa3-49e6-8c4d-fa455f0b96bb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "711915fe-c2e5-4154-8400-a906cf7f6999",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "38d5b331-9692-4aeb-82d5-aae26074caaf",
"company_code": "sample string 5",
"company": {
"id": "c77987b2-674b-482b-8641-3c5fa89a73a7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-13T13:19:23.8570323+00:00",
"sales_territory_id": "06d14abc-5225-4422-9a79-19bb9e4748f4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ed9a17db-4ca5-4efc-97e4-5e815549e09e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87a6ad3d-e9d5-4cbc-beab-d6e69b147550",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b006c814-81a6-4287-a663-9a7e0a953f3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "599e5c11-e099-4efc-868f-f5a446b909b4",
"db_currency_id": "3eeee512-b3cc-4bdb-9d35-1571c699ef05",
"db_language_id": "c0e3fbcc-0325-4a5e-a16f-63458f77b87e",
"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-13T13:19:23.8570323+00:00"
},
"modified_dateutc": "2026-11-13T13:19:23.8570323+00:00"
},
"marketing_segment_id": "6b7f7a05-ddbe-43c5-83fb-073507d934d8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "93d1a1e7-6913-4524-9c11-db82331ce7d6",
"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": "b83f9907-5f45-4134-9b5c-4b8641deb4b2",
"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": "4ecc772f-d8c0-4bf9-bafd-52d79d28321a",
"db_country_code": "sample string 28",
"feelist_id": "4402c959-b202-476d-8f0b-92d05bcf59a9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f121b86-e3cb-4c76-a306-2caf89b2ae61",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5a6e3a8-9d38-4796-a351-32ea8261d2d0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-13T13:19:23.8738699+00:00",
"db_currency_id": "bdd8d36a-202a-44f2-ab77-02d8ef615b8c",
"db_currency_code": "sample string 10"
},
"company_type_id": "72252bbe-385b-4626-b783-6bb8d1a5b8e0",
"company_type_name": "sample string 32",
"company_type": {
"id": "e069488e-75b0-4f5f-af7c-edabc843a2dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b40248e-c609-4943-aa1b-c6ec51b402ca",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7f9c98c6-872c-4e4b-a2f3-6dde5087d427",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8431ec76-e2a3-4f83-a558-a2ffc6a12389",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ec421381-5f14-4394-aac2-b3cde3952c33",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "766ef448-ceb1-4a1c-a35c-1e78165e079e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-13T13:19:23.8738699+00:00"
},
"company_sector_id": "54852a7d-6c37-4250-96b1-79aacea50cab",
"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": "97e7b098-a9eb-4ed0-aeea-1e3fb76872f4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "303430d9-0011-4b77-9823-6ea5eb1a8cbb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a0bb01ff-8c47-4eaf-85b5-2e8c54552bde",
"account_manager_user_code": "sample string 56",
"company_status_id": "c0e54fce-6feb-4286-b11f-c39d542a6f5f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-13T13:19:23.8738699+00:00",
"id2": 60
},
"db_language_id": "5905dc21-824b-4228-bac3-ef4221af141a",
"db_language_code": "sample string 7",
"db_title_id": "998f687b-a798-4d89-a77b-cdab67e80488",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-13T13:19:23.8738699+00:00",
"create_date": "2026-11-13T13:19:23.8738699+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-13T13:19:23.8738699+00:00"
},
"modified_dateutc": "2026-11-13T13:19:23.8738699+00:00",
"id2": 22
}