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": "25f66104-37db-48e4-8a58-b2256c05009e",
"_parent_id": "e9221efa-c0bf-4b8f-9b75-df2b2c7458eb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "02bfd290-4513-4c93-9fb2-6004e4c713a1",
"company_id": "1d3d13a5-4fc8-4888-a550-b5ac3bf93c81",
"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": "d3265705-c94a-4626-803b-ab2f10de62e6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6b1bc2df-5867-463c-b471-ff9094e69ab6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aa8d4c24-8f86-4bc0-bfd8-1e477fe36176",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "14ff6f8d-25e6-4ec7-8b74-ba08284f4393",
"company_code": "sample string 5",
"company": {
"id": "552d7906-8c2e-4c8e-a762-c60f9fc9ceb0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T05:17:40.8468653+00:00",
"sales_territory_id": "3c41e4e2-e336-4c1c-93bb-ac5904e5af93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "115f53d1-f341-4f88-808d-97ca52518ebb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7417881e-63db-4870-ad75-28d601efbce5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c79d7447-cd18-46b8-8f04-ec20e9008955",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "174c0c16-089c-4f4f-adab-afcd1cd416d3",
"db_currency_id": "0108c4f8-1a43-4669-a854-9b29bf9ef798",
"db_language_id": "5beadf2c-2076-4bf3-ad25-36f662132b14",
"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-09-07T05:17:40.8468653+00:00"
},
"modified_dateutc": "2026-09-07T05:17:40.8468653+00:00"
},
"marketing_segment_id": "4de78180-1af9-4820-845c-10ae25ffbcb4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "422c9c6b-8121-4fce-b9a1-ca944475a3e2",
"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": "27070db4-f85b-4087-ba92-97939bb11513",
"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": "89001b0b-2d17-4df4-ada5-5d78e5b3bc17",
"db_country_code": "sample string 28",
"feelist_id": "8419de65-4f94-4cfb-9108-abc2554d3b9a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "32acbf16-8255-4ac7-9a11-9c9f0b943750",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d59d8838-9874-45b2-b5ec-b2b1529303da",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T05:17:40.8468653+00:00",
"db_currency_id": "daac1248-37ee-4fa5-b8c2-879b6f8f78c0",
"db_currency_code": "sample string 10"
},
"company_type_id": "4b3d2e20-64b9-4e3d-bf6e-55deb9efca05",
"company_type_name": "sample string 32",
"company_type": {
"id": "50005984-7841-45dc-b7a3-27bad205e544",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0062b87f-b480-41d2-91cc-b1abc0ee9e1f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8280fc92-d5ea-4b28-af31-5689c2af8e88",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4b847a4-55a0-4533-8aa9-9471ed7d3cba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "488e6093-d5f3-42a6-8df0-5ba2aa8a19f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "97bd1195-6802-458c-b700-9c7975e12b69",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T05:17:40.8468653+00:00"
},
"company_sector_id": "21405423-9530-4fd9-a817-982aa246cc28",
"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": "ff0cae9a-10e8-4d7e-88b6-454c7e74b284",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fc044555-b043-4dbb-89cd-e7a9f4a66003",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e8b73a8-daaf-4167-9163-23141a317c8c",
"account_manager_user_code": "sample string 56",
"company_status_id": "0a1154bb-479a-478c-a347-11734b4b8c61",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T05:17:40.8468653+00:00",
"id2": 60
},
"db_language_id": "ba41efe0-830f-4927-8bfe-c6793a47bc00",
"db_language_code": "sample string 7",
"db_title_id": "3ffe38f7-d78e-490e-87ab-5bf37754d6af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T05:17:40.8468653+00:00",
"create_date": "2026-09-07T05:17:40.8468653+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-09-07T05:17:40.8468653+00:00"
},
"modified_dateutc": "2026-09-07T05:17:40.8468653+00:00",
"id2": 22
}