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": "d71f47a6-44af-45f4-8757-f59d51447b2e",
"_parent_id": "85603233-5ad4-427d-99ca-62886a02a25b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4bdbd682-7d8a-4dd0-a457-5907a627ae6a",
"company_id": "09373497-91e6-406e-8985-7e01cbdaff70",
"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": "261a3626-54a3-478e-bc2c-1fac63ec0362",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1c5bbd33-0d3f-4704-a91b-86d58374ea87",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9bafa6d8-7ebe-41e8-bb95-b013e67e21bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "524bb0e1-9c70-4d00-b4f0-10e00cf39ef4",
"company_code": "sample string 5",
"company": {
"id": "141bc2b0-2ad9-4e78-8a6c-150db4dc081d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T08:12:29.5638775+00:00",
"sales_territory_id": "be843013-9455-4c4f-96d2-6dd716e26517",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "273e2675-a5a0-4d44-9501-07300de51e80",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b512f9c-ab14-433d-9512-2bce4cee511f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ebaac27-5628-40d9-8714-74b050e1a1fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "423d87c1-5622-4676-9faf-c0f459d75a88",
"db_currency_id": "8a53fd2d-e83d-4276-a7ed-d85cee1c0954",
"db_language_id": "24a0c6b8-95cf-471a-b9d7-0d9cbe26a138",
"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-06-25T08:12:29.5638775+00:00"
},
"modified_dateutc": "2025-06-25T08:12:29.5638775+00:00"
},
"marketing_segment_id": "d8115949-5a76-427b-8d1d-95447be2dc94",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83ef3eb3-b0f2-4a25-9d5d-191bf7549dd7",
"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": "5f6914a3-c7a7-43be-9cb0-3409e237149d",
"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": "b01761da-bd26-42fe-b379-704aad307e77",
"db_country_code": "sample string 28",
"feelist_id": "113a2870-18ba-47a7-accd-7d14bff712f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3891269f-55fc-4b92-8cbf-6149859b762c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a49a3e94-8b8d-4091-97c6-70e1ffc9a321",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T08:12:29.5638775+00:00",
"db_currency_id": "c50159cd-6f1a-434f-936e-3b49ff0f3065",
"db_currency_code": "sample string 10"
},
"company_type_id": "586a4a75-0e7a-4d35-a52f-07907c4f3887",
"company_type_name": "sample string 32",
"company_type": {
"id": "0030ad83-6094-4b2c-bf14-4ae1282f7f95",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a185fe24-7c8d-4f08-9ce5-83ff5c92b8d7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a601e488-2253-4c31-a195-5a7496ee5123",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "92015ade-ef4c-4187-ab04-a3db40404ffc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7acf9c44-f42e-473a-bab8-9018125f65a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8c06f8c9-dce6-4927-a18f-88e4bae11e7f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T08:12:29.5638775+00:00"
},
"company_sector_id": "876b1de4-b082-4fc3-ab86-c755afa6a570",
"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": "4ebc2f31-ae70-4567-b068-96e4cd972f5b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0de9eace-b95b-4751-87ba-b9d7ce2ee644",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "98a81aa4-652d-42de-ade6-278331edddc0",
"account_manager_user_code": "sample string 56",
"company_status_id": "4fcb97bf-4770-45a1-94f4-24ea3c124961",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T08:12:29.5638775+00:00",
"id2": 60
},
"db_language_id": "b565c8cb-27d1-4974-bd65-3bbee82a4399",
"db_language_code": "sample string 7",
"db_title_id": "c8cb558c-1380-4bb8-b0b7-449a1f38cca5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T08:12:29.5638775+00:00",
"create_date": "2025-06-25T08:12:29.5638775+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-06-25T08:12:29.5638775+00:00"
},
"modified_dateutc": "2025-06-25T08:12:29.5638775+00:00",
"id2": 22
}