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": "967e6bd6-8e38-45ca-98f8-6c506e523db1",
"_parent_id": "416f121e-0fd9-4392-881c-29ecaaa1befb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e7b045fc-102e-47be-a865-f4d1c742deaa",
"company_id": "4a7fed3e-2602-4782-b844-c237ae9771a9",
"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": "949b8edb-4ee5-4ca5-aec8-8ad2113793b9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6a5bd1a5-568d-4880-acb3-759a3b995906",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "61a50d98-d159-4c48-b5b7-803a89324162",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2964aa38-c3d4-4590-9b6f-a1f107cba4e6",
"company_code": "sample string 5",
"company": {
"id": "68729721-b5d4-4608-9cc9-38175643cb36",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-23T11:41:22.767583+00:00",
"sales_territory_id": "06733a00-2543-4852-a57a-fac7da71e257",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bd4455af-7c91-460b-97ad-b31aca8f49d2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46b83315-9760-4edd-8f72-acb901c49921",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1658a83-5316-4830-906f-166649028b14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2f64c3-9e15-4f60-89d6-7002e7048e27",
"db_currency_id": "b9c26c47-7405-4320-b13c-a61df3c00c57",
"db_language_id": "d5991715-e975-4d30-adfc-29d0c6751fff",
"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-08-23T11:41:22.767583+00:00"
},
"modified_dateutc": "2026-08-23T11:41:22.767583+00:00"
},
"marketing_segment_id": "df3ed3cc-461b-4415-8560-c5b8b8b55684",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1a790de3-6d78-4c6d-af46-7b479cfbb9e6",
"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": "7091361c-82da-455d-b773-93666070b77a",
"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": "27d5fe0f-6b40-4cf7-8b77-180a4db5001f",
"db_country_code": "sample string 28",
"feelist_id": "0691a6e6-9120-46ff-8490-f1a17bf07227",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "57e1db2a-0a43-490a-b3aa-1e95e42ba65c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4946ca5e-7396-4db5-92f0-aaa529ae4f61",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-23T11:41:22.767583+00:00",
"db_currency_id": "55173cb7-156b-44bb-aa6c-77e92ae68131",
"db_currency_code": "sample string 10"
},
"company_type_id": "90e0e06d-1a52-4b70-8684-38afcb0d97e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "a9ce15f4-c360-462a-806e-8493a672f4bd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "807cea05-981c-4cbf-80dc-31b74c1df686",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6ae997e-df7f-452f-851b-d44985b08055",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4e161cf-53f8-4a25-b87d-d3673df596a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cf655b51-15ce-431f-8f71-966b53214807",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "722a3f42-b64e-405b-90dc-75fe1ec8e04d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-23T11:41:22.767583+00:00"
},
"company_sector_id": "c6881147-5fbb-4d4f-a177-bcd9bc3503b3",
"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": "40c5f80f-f1f0-40a8-91f1-9374bf82fd7d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9b7f9c0d-beac-4542-bad6-af784e8b043d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c77b3987-eb1f-4af7-b459-21257803a46a",
"account_manager_user_code": "sample string 56",
"company_status_id": "718e66bc-00d4-4e1a-b698-8c6d95b10be4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-23T11:41:22.767583+00:00",
"id2": 60
},
"db_language_id": "e943813a-bae9-4a02-be3d-48e188ab57b8",
"db_language_code": "sample string 7",
"db_title_id": "cbf04eb4-f960-4e83-8f84-330909bcac71",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-23T11:41:22.767583+00:00",
"create_date": "2026-08-23T11:41:22.767583+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-08-23T11:41:22.767583+00:00"
},
"modified_dateutc": "2026-08-23T11:41:22.767583+00:00",
"id2": 22
}