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": "a91257d8-1e90-4979-8666-d6c0083f640d",
"_parent_id": "022af6d8-2841-4b76-830a-b7f829b25d9b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "14e0439f-362c-4b7f-9c72-9c7781df0812",
"company_id": "90820b45-8528-4711-9125-d6ad6c22c213",
"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": "8e002e6f-ba79-4477-8976-d7a383660597",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1d08b7e2-ea0c-442c-b854-0c5661afe3b1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "752aa987-6cb9-49e2-b4c4-a2bd67aab22c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2bfd3fa8-c0fd-4838-981d-4c09242fb1ee",
"company_code": "sample string 5",
"company": {
"id": "a4c25516-e660-468e-8d9f-1f5867ec85ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T06:29:50.467415+00:00",
"sales_territory_id": "3292b8bf-09e0-4d44-804e-7734348b4100",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a3eaa4a6-5ee0-4b4f-8101-0b897d037c7b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16876d22-a93b-4f7e-8681-bfde2a395969",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d194fbd6-b3f6-4166-976d-3c78ed675127",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15058069-b769-49bc-9b0d-9d0b837be95a",
"db_currency_id": "90437618-5fd3-4145-8a65-f07d468cab1a",
"db_language_id": "83886d1f-2580-40c5-9c44-1ce337d042dd",
"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-05-01T06:29:50.467415+00:00"
},
"modified_dateutc": "2026-05-01T06:29:50.467415+00:00"
},
"marketing_segment_id": "910698b4-ea75-481d-bdec-9496c2d0bfb7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cca56d28-699f-4cf5-b78f-95a47a3bf1b7",
"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": "400bdcf9-f069-4cb6-bec4-31b195d51099",
"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": "27069b79-d6d7-4e30-b4da-43b08dc6cb09",
"db_country_code": "sample string 28",
"feelist_id": "6322cb44-f6ac-4f95-a143-068929d42b4f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1c3de498-f9f4-498d-9a91-4aa744b72f1d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fdbf06c7-a726-4429-a08c-f98a0d30cca0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T06:29:50.467415+00:00",
"db_currency_id": "3d9210ed-6290-4456-806c-d10057d7b99d",
"db_currency_code": "sample string 10"
},
"company_type_id": "bd599c89-4902-4e58-944d-f553c333f855",
"company_type_name": "sample string 32",
"company_type": {
"id": "d8ac81d5-bf0a-42d6-801e-97e9d469ac00",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1661393-afc7-43b7-823c-ae3df69be36e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8fc88cf2-12a4-423a-911f-dd33e72409fd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "584c43be-e501-48d7-90ed-1ddc0ac309d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "42097bc9-5041-4891-b5e1-5d7b71fea648",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "27dfb8f6-961e-4004-b404-319e9188d8cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T06:29:50.467415+00:00"
},
"company_sector_id": "ea07181e-7ba2-471e-878c-ca2a32d37294",
"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": "2f22f3a4-7ed0-45dd-abc7-54769a87bf32",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a9f5ad80-e730-4572-ad21-191a5a8192b5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce46405d-5980-4bc9-8d99-9bc12b0a5475",
"account_manager_user_code": "sample string 56",
"company_status_id": "893e964b-4c21-4926-9bac-73cc85dad16e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T06:29:50.467415+00:00",
"id2": 60
},
"db_language_id": "37110fae-dcf0-4318-a9fa-564eaecb83b5",
"db_language_code": "sample string 7",
"db_title_id": "9e475602-e749-4ef4-b487-a0bf4b01a189",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T06:29:50.467415+00:00",
"create_date": "2026-05-01T06:29:50.467415+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-05-01T06:29:50.467415+00:00"
},
"modified_dateutc": "2026-05-01T06:29:50.467415+00:00",
"id2": 22
}