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": "5bcbbf82-1424-49a8-b5bf-6741b575bafb",
"_parent_id": "e81505f7-ef6f-4270-ba32-076cb74bd62a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1c88ad16-a494-43b7-bca5-b7b07386a0d0",
"company_id": "340f14ba-492d-465d-8ab4-3aaf71c34c2f",
"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": "eee22d37-59c8-4ef3-afbc-eee3a5166368",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "58dcb67b-e094-49d6-8890-4b26d6f5e714",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "992d78bb-0347-4037-be52-0d99dd7031d6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "702261d9-a4b3-4e2e-a825-9a47f399ba43",
"company_code": "sample string 5",
"company": {
"id": "f77809f9-2bfa-4713-a6f8-c4bdd12c3691",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-10T20:56:10.8038348+00:00",
"sales_territory_id": "992ef7b4-c39d-45bd-9526-4032078036a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0d565fb2-03ad-46f7-b3c0-cce7c2d7aec1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d3ef811-7fb2-497b-b7bd-35f995fe4377",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "042e2fc2-b964-4e67-afd4-a3577bb1222e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00caf8a0-24aa-4010-acf5-6f2348a3cca3",
"db_currency_id": "ae0d3700-47a0-45de-81d9-da86bb5cf45b",
"db_language_id": "14529c3b-565e-43e2-a098-ff6e414e7a7f",
"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-06-10T20:56:10.8038348+00:00"
},
"modified_dateutc": "2026-06-10T20:56:10.8038348+00:00"
},
"marketing_segment_id": "8f477e9a-ad84-4ec3-8fbc-8bac5238f863",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6915199d-48a4-4bec-8820-c2cf894f4c05",
"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": "8a65c1b6-6a6c-48d4-8e66-b631499320c0",
"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": "273bd0e1-fe9f-4c64-85c6-bada894c1b36",
"db_country_code": "sample string 28",
"feelist_id": "b48e40f9-d5a7-4bbb-88c3-4d3c39f95a8e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cb2bcb38-3f21-489d-8ef6-9323e2d7165d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "88b7f73f-757d-4874-a2bd-22fb7e6c69df",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-10T20:56:10.8038348+00:00",
"db_currency_id": "e24eddec-5c5f-4245-9354-02845076e965",
"db_currency_code": "sample string 10"
},
"company_type_id": "94d94611-789d-4e18-9124-486d4a5b8614",
"company_type_name": "sample string 32",
"company_type": {
"id": "7631399c-fb4a-4daf-8d4f-0c5f9d8ee4d2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3f34f90-c7cd-4702-b99d-536c9f882164",
"sales_organization_code": "sample string 5"
},
"db_language_id": "284d1d70-4993-4f98-96e6-b8c77554850c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dbbbedb7-c655-44ab-851d-a1b5c7da8e43",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8cf552ca-3564-495f-bbde-b4c7b8fdd1f2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b12e1546-c6b6-4efa-96cd-4c537c69cf1e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-10T20:56:10.8038348+00:00"
},
"company_sector_id": "5f09127f-5277-4b9b-940a-36c9ff79f6ee",
"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": "fd5775ff-8404-46f5-a9c0-f5ce19c8dfb7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54f1a211-ac94-4064-bfd8-bf63919d95d5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a58a824c-7438-4d0a-b77b-ef5d3d9e5d55",
"account_manager_user_code": "sample string 56",
"company_status_id": "1ea335ba-0fd3-4870-9831-f92838470515",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-10T20:56:10.8038348+00:00",
"id2": 60
},
"db_language_id": "d06700ef-09bc-4c4e-a4ae-62cb30c85bf0",
"db_language_code": "sample string 7",
"db_title_id": "347e03cd-ca5f-46c5-bc07-067af7f4eb2a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-10T20:56:10.8038348+00:00",
"create_date": "2026-06-10T20:56:10.8038348+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-06-10T20:56:10.8038348+00:00"
},
"modified_dateutc": "2026-06-10T20:56:10.8038348+00:00",
"id2": 22
}