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": "379ea7a4-babb-4906-9094-30c2dfd09e7c",
"_parent_id": "84066633-6a01-4c4a-a471-54a9bb09cccf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "842528ac-28ef-4008-84d4-7a52f5f0c809",
"company_id": "47019265-6ede-44a9-92d0-69467180ef25",
"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": "513ee015-2cd5-40b4-a4d3-8005462aa7b1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "33aee5ef-ed6c-400c-9aac-a866091e3067",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6aa5773c-5cee-4a14-a924-4ac376b299a0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e4d548c3-0626-491c-ae7c-7897c7bef5de",
"company_code": "sample string 5",
"company": {
"id": "5718294a-8470-4095-8862-bdd9db91cf83",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T07:31:17.6283491+00:00",
"sales_territory_id": "78c95916-7240-4594-94d2-ef47364382f8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8dc2985a-47af-4b33-99ef-0205c3db42bb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b12dd68-5ef3-44a4-b94a-dde16c5157d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e13deaf3-25ed-4df1-8c15-0f03962fee3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9963c301-f56a-45d6-bc9f-af34bbafcea5",
"db_currency_id": "2472468b-e4b1-4e4b-91aa-3e45eaf43030",
"db_language_id": "4265382d-f124-4802-be23-2062688e2e88",
"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-07-14T07:31:17.6283491+00:00"
},
"modified_dateutc": "2026-07-14T07:31:17.6283491+00:00"
},
"marketing_segment_id": "94f52a8a-0708-4019-8351-fac5b287d5b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ce8c98c3-4e20-45f1-aa09-7c02126066a5",
"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": "d3eeeb4b-69ef-477e-841e-cfe7da5a9a1b",
"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": "bcf7de56-bb51-4e59-ad86-85469daf887f",
"db_country_code": "sample string 28",
"feelist_id": "49779b8d-e400-4731-ba33-c854125193f8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e19f3983-e979-4bcb-a320-3619651ed167",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e1efc5d7-d79a-489d-bf16-651b55b9fad1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T07:31:17.6283491+00:00",
"db_currency_id": "f529cb74-8182-4db5-814d-a544b23e9e79",
"db_currency_code": "sample string 10"
},
"company_type_id": "490e6bfa-dc6d-471d-810a-c573b86d9d5b",
"company_type_name": "sample string 32",
"company_type": {
"id": "8727a64e-cc0e-401a-b4f6-e5b74030d02b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b5bd214-1179-4a32-9d18-52973150dc3a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eafc4086-4e6e-4680-a619-49b8838137cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "22789cdf-b8cc-46b0-affe-4cf7e27c9059",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "86d37acd-8e6e-4d3d-aa7e-c203525c1ddc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "22e64555-38ef-492e-8e02-bd7690f0c061",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T07:31:17.6283491+00:00"
},
"company_sector_id": "bcd0e37e-8f64-417e-a756-76cf92dcb8ef",
"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": "ac6d4240-c912-46f1-a2ea-ae33b298c5bf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "63472110-e67f-4464-a928-4783d552ade8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e67e4271-ef67-42e1-bae6-467cfb6300a8",
"account_manager_user_code": "sample string 56",
"company_status_id": "4456af58-8ef8-430a-9e37-38b67c200b42",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T07:31:17.6283491+00:00",
"id2": 60
},
"db_language_id": "707325a3-e4c7-4b51-a63a-5580c622e108",
"db_language_code": "sample string 7",
"db_title_id": "c01af24f-4072-4a9d-b39d-6b17ae54ba54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T07:31:17.6283491+00:00",
"create_date": "2026-07-14T07:31:17.6283491+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-07-14T07:31:17.6283491+00:00"
},
"modified_dateutc": "2026-07-14T07:31:17.6283491+00:00",
"id2": 22
}