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": "726c0d94-fc49-4aed-985f-311526e08e9b",
"_parent_id": "e561b6c0-2136-4b01-8b61-88b336cc9a1a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a08e4a5e-f44d-43be-bf54-f36970bb9429",
"company_id": "4f93cf47-623d-4d69-aa3d-f1919510bba1",
"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": "15dc8da5-e1d6-4169-8304-0389db6334cd",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d62e841f-4240-4e00-bf54-9a389844f8e6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "eae3a03c-9a0b-44f6-950e-7c6d0c041f0a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8dc0d15a-34b3-4aa1-82f2-2320be2cf51a",
"company_code": "sample string 5",
"company": {
"id": "2567b010-cf46-4bf4-b03c-f25ab21c7286",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-16T19:44:45.6328205+00:00",
"sales_territory_id": "252731b7-d4f4-45f3-a020-e6524da35cae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2255ee41-c259-4037-8d2a-7ee12005e19b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8de84689-ce53-419c-b12c-d4e2868893c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8895895b-3be4-4e6c-a48a-5ba5ca86ba09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d62b19-b81f-4c77-8395-eae3638dfe55",
"db_currency_id": "216f3097-cac0-4761-ab64-856a8d6504cf",
"db_language_id": "3c11fb91-3754-4488-bcf1-a39955d7d212",
"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": "2025-09-16T19:44:45.6328205+00:00"
},
"modified_dateutc": "2025-09-16T19:44:45.6328205+00:00"
},
"marketing_segment_id": "31c8e1f7-db81-4e8d-a287-eaa9a521ec42",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "854570fc-f2eb-4ac7-9fb2-2527a43864df",
"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": "ae5a8ca3-64d4-48cf-bafb-13801dfe1a0f",
"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": "87592fd1-d9a1-4289-bd3a-e671dfa1cb39",
"db_country_code": "sample string 28",
"feelist_id": "c06b4cb8-965e-46b9-82a1-ae80e9959dfa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "28d07d8a-83fb-44c3-a456-4d0b0ecdc18b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a840bd6-3d70-436d-abbe-34a60b5036f7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-16T19:44:45.6328205+00:00",
"db_currency_id": "312d3dfa-9e59-4086-942f-fe1962069933",
"db_currency_code": "sample string 10"
},
"company_type_id": "efa8d5a7-569a-45e1-94d6-a4e5b1db45ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "172baa8e-3492-407e-b9be-a14fdb754335",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5fe344ef-a38b-4785-82cd-c64091268b2a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "505ac12e-01d9-454c-b5bf-159622e409a0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9a309e7b-3aa2-428a-870a-e29b2ce0efea",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "145264ca-399d-4425-aef5-a85e50c8267f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "403931c3-a9c5-408f-af7b-8e3542362604",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-16T19:44:45.6328205+00:00"
},
"company_sector_id": "fae7af58-ab7a-4463-89d7-94777444cb2b",
"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": "27fd3492-3b53-48c0-a8c6-db5be3c18981",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41654ac8-0cbe-4db2-a35f-26ef2e247e41",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0aba98c4-e7c6-46f5-aacb-85055d2d7491",
"account_manager_user_code": "sample string 56",
"company_status_id": "d9f064bb-c5d0-4375-89bc-2b456500205d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-16T19:44:45.6328205+00:00",
"id2": 60
},
"db_language_id": "3c62579f-a9af-434d-b351-e6e80544e6a5",
"db_language_code": "sample string 7",
"db_title_id": "ef3c3c9b-e275-4363-9371-c7173868a2af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-16T19:44:45.6328205+00:00",
"create_date": "2025-09-16T19:44:45.6328205+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": "2025-09-16T19:44:45.6484462+00:00"
},
"modified_dateutc": "2025-09-16T19:44:45.6484462+00:00",
"id2": 22
}