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": "99becc85-f4be-4448-a421-5ccaf45b62aa",
"_parent_id": "8075c7e1-f439-451d-9ebf-044ecf2b9c28",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6fc2ad90-4a0e-4b37-afc0-4aa9e955b92e",
"company_id": "71266ab1-6350-40f5-bce5-da56e05722dc",
"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": "b4a583ca-b580-412a-ad62-db4abbd6c2b6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7592ccd7-45f5-45ba-92da-9af640022c8c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "33e7a014-f4fd-4642-a563-a8252ef8ba09",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7b5afdf9-c76c-4885-beac-b7bb5b9e9527",
"company_code": "sample string 5",
"company": {
"id": "5d7db90f-9021-4f56-af99-94870f032875",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T21:45:12.0666505+00:00",
"sales_territory_id": "03b23b63-c42d-40af-8253-f5b32c271f6c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b92a9ee7-c3f7-40ac-89c4-4001b2132671",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7da252a3-f872-48fe-a83e-1f5b85321404",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "02af8335-455c-40e5-8b5e-09f9555f4f75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf10c16e-756e-42b0-9add-bb585330e6af",
"db_currency_id": "dc272311-8800-42da-85da-2d6c4fbb7678",
"db_language_id": "4418259e-38ee-48f5-a73e-5efe1180f59e",
"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-22T21:45:12.0666505+00:00"
},
"modified_dateutc": "2026-09-22T21:45:12.0666505+00:00"
},
"marketing_segment_id": "23f35086-ecce-43f6-ab6f-df5a1022fc55",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0312693a-99c2-4984-9f9a-7de0f29785b9",
"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": "9e82e203-a810-47dc-9dae-83ec686c804d",
"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": "6d04c48a-1496-40bd-9581-a7b4cbca0738",
"db_country_code": "sample string 28",
"feelist_id": "3001c5e7-ba50-4bf2-801c-b1d85d86dca6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "aa364d4b-cfcb-4bfa-9dc2-d5a0884a1053",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b551ca92-0945-431f-be4c-e00d888c18b8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T21:45:12.0666505+00:00",
"db_currency_id": "8eb40c0e-c6ee-4f8d-a218-7df236b8b95a",
"db_currency_code": "sample string 10"
},
"company_type_id": "4af92917-3e6e-4e64-a26f-533e933f6b0a",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d313bff-29fc-481c-899b-2337c7379f77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9effe917-06bf-4f9b-9c49-cc45ddd861d5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a41b75e0-e6f7-4799-bc8f-18a5b8d48f84",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "767dda3d-b285-42e6-9470-a00e9f8afe80",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25a48b9a-3b47-446e-b809-c30f69079e2d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1bd17a66-698a-456d-a8fe-890979074910",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T21:45:12.0666505+00:00"
},
"company_sector_id": "d9236771-777c-4d6c-886b-73a499f759e5",
"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": "b0effd6e-1188-48f5-869a-7e383436803d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23acdbde-94eb-411b-853f-824fbc08284e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e0b4ab51-4906-4954-994a-2e195f532783",
"account_manager_user_code": "sample string 56",
"company_status_id": "d75d8d23-28e6-4a61-a2dd-8e83a571b955",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T21:45:12.0666505+00:00",
"id2": 60
},
"db_language_id": "e3de976c-7109-4eae-8606-183e2f588343",
"db_language_code": "sample string 7",
"db_title_id": "f4697daa-1412-49ad-a32a-29d88032de9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T21:45:12.0666505+00:00",
"create_date": "2026-09-22T21:45:12.0666505+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-22T21:45:12.0666505+00:00"
},
"modified_dateutc": "2026-09-22T21:45:12.0666505+00:00",
"id2": 22
}