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": "0a08093b-3edb-4ea8-9bf7-efc171951bea",
"_parent_id": "a539d856-9730-42df-a3d3-80582062c812",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "79a3a4a4-d0df-4684-a1e2-9182fc567af8",
"company_id": "476a11c1-19c2-49f6-986a-a7e46b7043bd",
"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": "cd8af916-5894-4d02-a822-32cb585656ef",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "38ca4a6b-acb8-4628-af21-f3e7a24dd559",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "78755609-d012-4b66-b20b-1865ed87417c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9907c5d5-6220-4375-a66f-7d98add099fe",
"company_code": "sample string 5",
"company": {
"id": "51ab3529-ff47-47bf-88e3-e91b51f936d7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T06:21:10.4972268+00:00",
"sales_territory_id": "5c40d50c-12cd-4fcc-be48-35d3d2ac2aba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "78016407-5ae9-47fc-a2e9-152c81965c4f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "863de9b7-5efe-453f-8127-2e38b18504a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ca3fcca-5250-4dbf-af7c-fab4bc3bbaec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a1e439b0-9401-4168-ab2d-779c9653bbab",
"db_currency_id": "e03adae2-4d39-499a-84bd-d48f4182100f",
"db_language_id": "ad64d596-b69a-46ee-9c7d-c73faaf8ef67",
"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-12-23T06:21:10.4972268+00:00"
},
"modified_dateutc": "2025-12-23T06:21:10.4972268+00:00"
},
"marketing_segment_id": "12e60252-41ec-436a-835a-34bcf8e8f363",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "19910fa1-7277-4b94-a412-3abd69e01523",
"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": "f4659ab9-4189-4d69-bc88-c44b15e2ea1b",
"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": "c03862e6-bf5f-41b0-afc7-486b8730de3d",
"db_country_code": "sample string 28",
"feelist_id": "b03261cd-9f87-434d-9f74-0ca3f31f7a7e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3a9d105a-f2a6-41a8-961f-d7979815d3f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1bd294b8-e3c4-40a5-bf2f-f68cd311b331",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T06:21:10.4972268+00:00",
"db_currency_id": "448d3de6-f9ac-4a2e-a0a7-8ddc5b496c02",
"db_currency_code": "sample string 10"
},
"company_type_id": "5dee9c83-cdb5-4e21-9477-7e72b6c80495",
"company_type_name": "sample string 32",
"company_type": {
"id": "70abff0b-7ddb-4689-a73d-a93adbb16c54",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f95a24e1-8599-4528-8a2f-21c111dd5705",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bd99a3c8-4bb3-4b09-8ad9-c0277d67c191",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "42bb0253-f0fa-42fe-b82b-71fabb04fe46",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "115075d9-4cfa-44d2-b28f-bf5b4a425889",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0c1ebda7-58d5-43ac-a578-84ee8d453947",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T06:21:10.4972268+00:00"
},
"company_sector_id": "3f628b6d-9de2-4971-8132-9212f97610db",
"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": "07befe7c-27e7-4ff4-bfb7-1c1cfae4bd60",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6acd9cf6-6640-455c-b862-4694765f03d7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c07662a7-a00a-4519-8b36-e8c2f04ffa0f",
"account_manager_user_code": "sample string 56",
"company_status_id": "bfb44e19-3bbd-483d-ad9f-1a4bd9ddc997",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T06:21:10.4972268+00:00",
"id2": 60
},
"db_language_id": "986de245-a459-4425-af52-c8059e7b81b8",
"db_language_code": "sample string 7",
"db_title_id": "69c9e893-6c43-4f5b-92c4-94ca46a53113",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T06:21:10.4972268+00:00",
"create_date": "2025-12-23T06:21:10.4972268+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-12-23T06:21:10.4972268+00:00"
},
"modified_dateutc": "2025-12-23T06:21:10.4972268+00:00",
"id2": 22
}