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": "c0a5fe30-218a-4993-94c1-08259e21d2d3",
"_parent_id": "5c81cdb3-236a-4bdd-8f92-3fa2d82e3aac",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "da64c5ad-8ebf-4672-b5b3-13a5f4f3bf60",
"company_id": "83ebee3e-e53d-4db5-b516-263f4762399d",
"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": "c438ad90-b04e-4271-8814-5d5b9720dc31",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e1051e22-4b9e-4115-8b3d-ec899a0fcd43",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8057a8b3-d601-4dac-a4a8-bafc9b3550f9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9b73552e-72c8-4c7a-8636-1aaa48e3d597",
"company_code": "sample string 5",
"company": {
"id": "e5e38fc9-3d46-43d0-9331-8b204717e9ba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-20T08:14:48.9420374+00:00",
"sales_territory_id": "776dd1db-5fc4-4c41-b7c5-25b03af4f0e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "823bbb65-06ae-4076-8719-438e1007f615",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "150a1253-6686-4a51-9f8d-dcf6ec65be25",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ebe137eb-8ea1-40fe-8efb-3c0eaf24cdd0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84d0546e-e603-461e-969b-17daafdcaa5a",
"db_currency_id": "ba85d234-484c-47d9-8782-5aed3f959eaa",
"db_language_id": "096f58a7-78d8-48c9-86c0-36ad3ac36280",
"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-10-20T08:14:48.9556708+00:00"
},
"modified_dateutc": "2026-10-20T08:14:48.9556708+00:00"
},
"marketing_segment_id": "42d408d9-64f1-49e4-9783-88f81ad84c0f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "919836d5-624c-4574-ad1c-89ca46bb68a0",
"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": "13653f76-4dff-4909-881e-e5c7f96fe646",
"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": "d00a671a-437b-4dfe-9831-a31914db4758",
"db_country_code": "sample string 28",
"feelist_id": "dd9fff20-cca4-4b35-857b-c8c2e2f443b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b37dd2e6-a863-47b8-b798-32d3b9799e99",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "de6d8391-4253-44ba-a20f-d3ae667b7aad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-20T08:14:48.9556708+00:00",
"db_currency_id": "31a60d53-2670-4d02-9b0c-8c7ceb123e82",
"db_currency_code": "sample string 10"
},
"company_type_id": "8df7fb7d-6752-4fc8-97d1-fc7b6a3e3fc0",
"company_type_name": "sample string 32",
"company_type": {
"id": "c01ab068-0846-4656-ad48-18b37ba85379",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82bac64e-22a4-4b34-9e0e-457fa3e6b0c0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8f8a996d-064e-469b-b181-d2ae3002587e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4955ee2c-9aa3-4390-b4cb-9623fa8b1a78",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "40319485-a343-4a1d-b573-ad1944bbd26f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e811bf66-0dbd-4304-bf14-34067ede9241",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-20T08:14:48.9556708+00:00"
},
"company_sector_id": "865686f0-b082-410f-b23f-4c63db18b9b9",
"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": "2747f945-7196-4c1d-8424-f4de308280e2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "83581a12-572b-4a6a-9cb4-68ed98d79bab",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b38b9d91-57c2-48b3-9726-1eac728f295f",
"account_manager_user_code": "sample string 56",
"company_status_id": "2d078b3e-0760-408a-9051-c954eb6b2b98",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-20T08:14:48.9556708+00:00",
"id2": 60
},
"db_language_id": "2d0c300d-c2b2-4720-9e2a-61a208f86ab8",
"db_language_code": "sample string 7",
"db_title_id": "9a96996d-da6d-4d3c-884f-96471b10933f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-20T08:14:48.9556708+00:00",
"create_date": "2026-10-20T08:14:48.9556708+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-10-20T08:14:48.9556708+00:00"
},
"modified_dateutc": "2026-10-20T08:14:48.9556708+00:00",
"id2": 22
}