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": "a6a4122b-d703-4ae5-a0cd-5efbb841d96e",
"_parent_id": "b64ec056-aac5-4e81-b8a3-ffb8a726950d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "61af449f-bedf-480b-972d-d28ecfd6fc35",
"company_id": "b2f1ac15-9601-4251-875a-d53ad61a5241",
"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": "16061135-0dfd-4110-88d5-5de57591eb37",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a590c81f-1ddc-48c8-bf45-521a1a4dbc1b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b1f83739-f099-49ec-bc1f-1a88f6350353",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "15a1ecaa-21f1-4a1f-9b77-d1925a356cdc",
"company_code": "sample string 5",
"company": {
"id": "1f488818-bd49-474e-b6f8-704bf963733e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T10:14:07.8981688+00:00",
"sales_territory_id": "68a7bf3b-9ea9-46a9-a7d9-d2f507135231",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d1dae945-cbe9-4ee7-95c0-a5496760fe26",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a264591b-55aa-4794-9091-2ca636673318",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d4600cc8-b8cf-4830-858e-237ffc0d162e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92028cfc-ea32-49a2-8f33-656e88255fc0",
"db_currency_id": "bed46f34-f233-4ad7-a42b-26ba86df60b5",
"db_language_id": "c4feda27-fefb-4231-87f7-e50e9366f86f",
"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-18T10:14:07.9137871+00:00"
},
"modified_dateutc": "2026-01-18T10:14:07.9137871+00:00"
},
"marketing_segment_id": "e9559e5e-5bf2-4b38-8a88-2f708cf42638",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e18d6de1-1629-4c5f-9977-bb5feb5c32f6",
"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": "497c0e00-b79e-4ce5-9cc9-416ebd3e7238",
"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": "c5edf386-5dc7-4b70-ace1-6c74127d4bba",
"db_country_code": "sample string 28",
"feelist_id": "72c9ccf2-3190-4026-895b-cb4f0bb73b15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f88cd219-c5de-466a-8aa1-de45201b91b8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f86383e9-5c29-44c7-88ac-8f0a47459150",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T10:14:07.9137871+00:00",
"db_currency_id": "58cd58aa-b8b4-48fc-8116-6dd5b6a2fc79",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e8e2791-d90c-4ee8-96da-5c76ed6e0ae0",
"company_type_name": "sample string 32",
"company_type": {
"id": "a5c32dd1-d6a1-46a0-9d11-6672227f2ca7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90f1d365-a009-4090-b8ea-aff7febebb56",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b19f467c-f39f-4af1-b72a-47499fb2ab08",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b25c4c3a-1c1e-4559-a4c3-37752f3b1a57",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "67a56d48-d916-4135-91cb-3f8c2e21ee5d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1a65d707-9760-4aff-9557-ac2037b98f92",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T10:14:07.9137871+00:00"
},
"company_sector_id": "0add7e00-f1de-454c-bf19-79c14596b85b",
"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": "b76df6fe-fa1f-4537-9e78-4def64cb3771",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8c9533c9-be36-44d1-b6b9-7867bfde5de3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bfbc0d82-0051-4a43-b631-3ac2cde7078f",
"account_manager_user_code": "sample string 56",
"company_status_id": "955401a9-5ddb-4769-94f9-0e66c5793e26",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T10:14:07.9137871+00:00",
"id2": 60
},
"db_language_id": "23841828-e2e2-440d-b040-697ec398efb8",
"db_language_code": "sample string 7",
"db_title_id": "8b443476-e458-47f7-a38f-4ae6bce506d0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T10:14:07.9137871+00:00",
"create_date": "2026-01-18T10:14:07.9137871+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-18T10:14:07.9137871+00:00"
},
"modified_dateutc": "2026-01-18T10:14:07.9137871+00:00",
"id2": 22
}