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": "dd085708-3fe0-4249-9ab8-5ebe1ac2e4e2",
"_parent_id": "eb5355ee-d4ed-49d3-8873-748487cde4d8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7dfe7df1-b900-4c33-b5f0-05eb417a468c",
"company_id": "948daa7e-94ae-4133-aa1a-f99d42bc7116",
"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": "8219785a-c0e7-4d5a-b68e-a3bd1cf4ead9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7c521dbc-9fa4-45bc-a21d-97e8b65e1d4b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1aa2f3e5-7bcb-4612-bedb-892145ec0df0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bf647e97-abc4-4d65-a7db-3c54a545d44a",
"company_code": "sample string 5",
"company": {
"id": "1a785361-aaeb-4fc4-98b9-70165692d425",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-05T03:21:45.5725032+00:00",
"sales_territory_id": "42fac7bb-1cd3-4787-b7b5-680174bd64ff",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "659a6d39-3e2e-4979-b493-31a650467e62",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef84c434-7e66-4fbb-872f-504557264e21",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "60fedd04-5088-4a89-ac0b-0ac19852b36d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a969cbea-1bec-4b29-bccb-3caeee190ad9",
"db_currency_id": "d709d5b7-c063-4656-8f27-65c58b958cda",
"db_language_id": "9965a439-f1f7-4b4d-9264-7ddcdebe2f38",
"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-01-05T03:21:45.5725032+00:00"
},
"modified_dateutc": "2026-01-05T03:21:45.5725032+00:00"
},
"marketing_segment_id": "4b85413d-7bde-4b2b-a941-90e95f64addf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c03a29bc-c07a-4ef2-b945-b3b8c6679ae6",
"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": "9d1349d2-1653-48ef-97f9-41ac37a0b68f",
"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": "f0f82f09-918c-4f5f-a7ea-37fe1e7f3077",
"db_country_code": "sample string 28",
"feelist_id": "15a03130-9898-4525-8968-f5a66501dce0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2bd47ba-1181-42bf-a7db-2ebf5c296069",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9ddbe984-58b6-47da-97c1-d381d59ffa0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-05T03:21:45.5725032+00:00",
"db_currency_id": "85b27024-05d0-4619-a18b-ea824e0a07c3",
"db_currency_code": "sample string 10"
},
"company_type_id": "98e2829b-369d-426e-afbb-b083cb1f7ad6",
"company_type_name": "sample string 32",
"company_type": {
"id": "f3357f39-d06d-485d-ab61-a339b894b9fe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79e67c1a-a0d7-47f9-bf25-2deb24b8f284",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f5afb1ca-bbfe-4543-92c3-0bb8c468315a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "19c89420-2512-41f2-9a3e-0c67da3219f1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e11d59b1-7112-4eb9-b8e4-591310f8c8d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d4b170b6-a0a8-45a2-b55f-0f333ddfe140",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-05T03:21:45.5725032+00:00"
},
"company_sector_id": "18db72ad-d7d9-4fc1-9424-f1e063ec2a19",
"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": "b71aad47-0bdd-4431-81e3-6eb19486064b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "463e3d81-b361-49c3-a96e-d392360ac0e5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "27e49f67-60ef-43e7-8ab8-0e0e632c7fb6",
"account_manager_user_code": "sample string 56",
"company_status_id": "04a8b09f-8a39-41d3-a950-42fe01a90105",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-05T03:21:45.5725032+00:00",
"id2": 60
},
"db_language_id": "879b8b9e-6a7c-4a42-af7d-afa4d7a00420",
"db_language_code": "sample string 7",
"db_title_id": "40e2025b-cce3-45c3-8649-c26b26430d35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-05T03:21:45.5725032+00:00",
"create_date": "2026-01-05T03:21:45.5725032+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-01-05T03:21:45.5725032+00:00"
},
"modified_dateutc": "2026-01-05T03:21:45.5725032+00:00",
"id2": 22
}