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": "27f59dd2-3e0c-49cc-81c0-76e54dd74ff1",
"_parent_id": "5df02297-c6e5-4e59-9955-5fbcc88fc55f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "992897c5-c48c-4560-a90d-812d9942b31d",
"company_id": "c21da167-152a-4e77-be0b-c9686a287111",
"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": "2ebd7d40-ed75-4935-b9eb-a38d6eea266e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d0f3c7df-d257-467a-ae14-2587e27378f2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "17cb4598-ac7d-466b-9348-9c7d1f38ebe4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "41dee504-c244-472e-bc40-d7b9ea81141c",
"company_code": "sample string 5",
"company": {
"id": "4b3c82ff-c7ac-407b-9e4e-c959d22325a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T02:36:36.3589949+00:00",
"sales_territory_id": "cf957a34-0fb9-4c05-a43b-1b4227d40a4f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fdb5335e-dd8e-425b-b60f-c78855057aa7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21237381-1b3d-4684-8e31-091c856aa5cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f137308c-442c-49f2-9742-4598ada9971b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57c54c41-f596-4b0c-997b-948b34a66cbd",
"db_currency_id": "2a255c58-d7c0-4f22-aae9-18eecb58031e",
"db_language_id": "fd380b79-74f3-412d-a453-c8d65691ae85",
"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-04-03T02:36:36.3589949+00:00"
},
"modified_dateutc": "2026-04-03T02:36:36.3589949+00:00"
},
"marketing_segment_id": "ec9d078d-9706-4730-bb94-c14497606f43",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "33287746-ded8-426a-9f88-578111e41f6b",
"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": "50270933-ec90-4676-add1-05ba0c71a7ad",
"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": "bb005d27-67d6-4e58-acbd-5e13988ff9ed",
"db_country_code": "sample string 28",
"feelist_id": "4215057a-0369-46da-b572-2dd190a61953",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3c66f9e1-8b0f-484a-b048-1541adf4a224",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ce33a86a-d218-4fc4-b92c-47f349268819",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T02:36:36.3589949+00:00",
"db_currency_id": "314cc501-05e6-4a07-8d68-8b622a1409b1",
"db_currency_code": "sample string 10"
},
"company_type_id": "7867d382-30fb-4bc1-ba11-c026d8cc1c21",
"company_type_name": "sample string 32",
"company_type": {
"id": "2ba84ed3-80e1-4292-becb-dce6159ea11d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c28ea58a-99f6-46dd-a5ca-c85dab1d57c2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ac0c9309-92d4-47ed-b3ac-a194a4cf7e0f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6a65d778-270b-45ce-9ac2-06d70961c66f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "038af2e6-dfdd-46a4-9aae-f1353c5f28bf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cada3e2c-62c9-48a8-976b-c95e429e6c05",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T02:36:36.3589949+00:00"
},
"company_sector_id": "b6b5e3a7-6de1-4de1-9dcc-a3089a4cdd52",
"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": "092a51b5-032c-44b3-a9d5-4788e77f497d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7ccd5a93-fd43-4093-9354-0099bd5dc9e7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8feb32b3-98a8-4d01-9178-df1b8ec124e6",
"account_manager_user_code": "sample string 56",
"company_status_id": "255fecb3-2bdf-4833-aa1e-71c4bb14e790",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T02:36:36.3589949+00:00",
"id2": 60
},
"db_language_id": "e5302088-a33f-47f4-aa15-78bc8ece0ad5",
"db_language_code": "sample string 7",
"db_title_id": "0f7f84b9-caba-4274-9bf1-bf33fdedc588",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T02:36:36.3589949+00:00",
"create_date": "2026-04-03T02:36:36.3589949+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-04-03T02:36:36.3589949+00:00"
},
"modified_dateutc": "2026-04-03T02:36:36.3589949+00:00",
"id2": 22
}