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": "45391b69-d0ea-4d5d-a55e-b9c84ddd0772",
"_parent_id": "a97b5821-f617-4614-8a41-22395dfd6d9d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cd5c8463-160f-4d6f-b1e9-19f0207a393f",
"company_id": "c0e37f38-df15-4e16-936d-c04268bc6c17",
"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": "9c42e484-85dc-473e-84aa-443e710ef892",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "64089e08-1ec1-4e1a-bfc8-95e8ea39fe4b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0991b4a6-0d29-4a0f-a735-ba65dc0e4616",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cd802a13-757f-4c69-a4bb-b9e1840ae975",
"company_code": "sample string 5",
"company": {
"id": "8a83cf7f-adba-4cdb-a927-cd07d6cb612e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-24T06:20:14.2891543+00:00",
"sales_territory_id": "eb7aea6c-233d-42e9-9967-a42147d20427",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5ea5464d-1d0f-45f5-9bec-2ee1959371e0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "017f31bf-91c0-42bb-b336-c8a4e68fbcec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa7db920-20a2-464c-b589-eb62931ed59b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1492cb4f-863e-497f-91ab-32ada45bf6b3",
"db_currency_id": "16ceb971-710a-43a1-b6c5-93ce6926501a",
"db_language_id": "92bf7e54-4a91-41dc-b8fe-a1de179e92d6",
"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-08-24T06:20:14.2891543+00:00"
},
"modified_dateutc": "2026-08-24T06:20:14.2891543+00:00"
},
"marketing_segment_id": "da73220d-8f66-4aeb-873c-9296ec1663e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "93cb782f-4435-46d3-9a70-e426c6161106",
"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": "ca309194-9112-47ff-8244-47eba6e4a40b",
"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": "a331f940-c29c-4a57-afae-a0d8dbfc5f4d",
"db_country_code": "sample string 28",
"feelist_id": "d7a21e8c-98f1-4f53-8de3-ef4a091a3653",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18587ddb-5685-424c-8e61-b935afaeddc9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1fd1ad1a-f5ea-4482-ae1c-58a8e376dbb9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-24T06:20:14.2891543+00:00",
"db_currency_id": "4c7cccd8-7b62-4559-b116-695bc6a2378f",
"db_currency_code": "sample string 10"
},
"company_type_id": "6812e196-5102-468a-9a60-eb45be422866",
"company_type_name": "sample string 32",
"company_type": {
"id": "89df0162-f1fb-4d99-914e-f88831471ac0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "86fa3904-b0d6-49e5-850d-ede8e04b0538",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d4644f71-8982-4366-9693-e0cc3f06f63e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58cc57cc-c9c3-40a9-8f15-e5165284c880",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "68bdc93b-c7c4-4c6b-84f2-5a85ecb32947",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7825a1fa-bbb0-4d95-89a6-812061ec0870",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-24T06:20:14.2891543+00:00"
},
"company_sector_id": "d21e9544-c35a-4d1f-922a-991c734eb8f9",
"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": "6c7fcbaf-4270-4794-9854-549699934f0e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e2ac8fb0-e310-49f7-be04-16ed9b8eda99",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3b0daee0-5dac-410c-aaad-888abc37fece",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ca659be-ff38-413a-8b87-ca1adf8d2c2e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-24T06:20:14.2891543+00:00",
"id2": 60
},
"db_language_id": "c95f87cb-1ae1-4ea0-922c-492cb483fc46",
"db_language_code": "sample string 7",
"db_title_id": "3f65f05c-b2bb-47af-9cae-b985fa47bd6b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-24T06:20:14.2891543+00:00",
"create_date": "2026-08-24T06:20:14.2891543+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-08-24T06:20:14.2891543+00:00"
},
"modified_dateutc": "2026-08-24T06:20:14.2891543+00:00",
"id2": 22
}