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": "8de30b43-5f4d-42df-b1cf-678a4cba68c7",
"_parent_id": "ea05bc65-048e-4708-a3b2-77e391bbe810",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6aeccc3e-0335-4037-a3bf-a851cfdb17b2",
"company_id": "f792a65f-e474-43f7-a68d-dda2454e09d4",
"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": "b50bc18e-3e4e-4753-886e-eff30f286281",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "906ad21c-d6fa-4e62-a64c-1f99c335bbbe",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0f4d5315-6815-41d4-8703-8f514e255532",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee97bde2-dce2-4598-9de8-ea914c086026",
"company_code": "sample string 5",
"company": {
"id": "38509f0c-e685-4a75-ad2b-5723bec3c075",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-10T22:26:25.7689735+00:00",
"sales_territory_id": "150dc205-e316-40bf-83d3-0f856379d136",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "779603c5-67f9-4f1b-b8d1-86f0d7f80f82",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64208235-5781-4414-b3ff-bfe65219b07d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fbffb49d-2330-4a1d-8e9d-8d2439ac831a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f2817ca-3365-40cf-a026-7c47364daca0",
"db_currency_id": "6624b771-2c6a-481b-ab0f-28a3eed16035",
"db_language_id": "cea8bc4b-7360-47f8-95ab-ca538c5a0591",
"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-10-10T22:26:25.7689735+00:00"
},
"modified_dateutc": "2026-10-10T22:26:25.7689735+00:00"
},
"marketing_segment_id": "4a08d55b-841a-45dd-9e87-d69a038c6329",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dd884ea7-f1e6-44f0-9d1a-34f36c1221bc",
"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": "ad06ee73-00ca-4d36-8b3b-6a4881d66c89",
"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": "281988f1-dbcf-43fd-9c1a-4e6c4e3541e5",
"db_country_code": "sample string 28",
"feelist_id": "d6684ce5-961a-48e5-a3f3-3f50cba512a8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3622edf4-3d77-41df-8f7d-22bc52d8dce1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f6e7432d-0374-4690-8517-35eb286012d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T22:26:25.7689735+00:00",
"db_currency_id": "dcc11595-8e4d-407f-821c-856a94e42b25",
"db_currency_code": "sample string 10"
},
"company_type_id": "3ab2eeb5-3b0d-45c8-8d52-8f0847fe5e05",
"company_type_name": "sample string 32",
"company_type": {
"id": "0a2bc575-6379-4382-a973-02423c140af4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3e459e6-df87-46ae-b738-e6f6c072ad1e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "230d41f7-f55b-437e-963c-9bd4e4e474fe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1b9f5028-3fff-4563-af29-7dac37cebd9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0d6d5a4a-4df1-4b7e-a902-f6de325f7cd3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "14cbbceb-4ee8-416a-8bbd-36f3716ce9ce",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-10T22:26:25.7689735+00:00"
},
"company_sector_id": "021c52d0-c7f7-4c6a-b36f-151d84d1bb57",
"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": "4af043b8-30d8-4ad0-8260-3f8cbbf071b5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41bed00b-47af-4e14-9325-8e027ea034a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b64e1943-fdd8-4a13-8553-62409d262c9d",
"account_manager_user_code": "sample string 56",
"company_status_id": "e8f2d16a-8d1a-4cf8-9078-8971fb6eefd5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-10T22:26:25.7689735+00:00",
"id2": 60
},
"db_language_id": "be5f17ac-1b7f-4f6d-8681-246a42bc9a5f",
"db_language_code": "sample string 7",
"db_title_id": "cee4abf8-7973-4364-b5d1-4fba78d543d6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T22:26:25.7689735+00:00",
"create_date": "2026-10-10T22:26:25.7689735+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-10-10T22:26:25.7689735+00:00"
},
"modified_dateutc": "2026-10-10T22:26:25.7689735+00:00",
"id2": 22
}