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": "b57636de-2dd0-4a5a-bedb-7ff092defa48",
"_parent_id": "5d0b3abf-9167-47d0-a203-bb065364903f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3454fac3-781d-4724-b28f-e5e1949aeebf",
"company_id": "a8cdd67b-71ea-4620-8674-af24f85a2604",
"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": "e5a1ceb1-5986-41a5-ad63-17166179c7c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c0800da5-0c94-4494-9add-8e8e471c48fa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9dd5192f-6f66-4810-b1e1-74c4287780f0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81b0e23a-764e-49d5-8c7a-1cff31526dc2",
"company_code": "sample string 5",
"company": {
"id": "171e70e5-b681-4d81-add3-4c2e7a74f251",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T07:44:51.272618+00:00",
"sales_territory_id": "47bf20ab-f88a-4b4f-8b4b-9144a13f5ceb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cba4b4f1-fb57-4f4e-9bea-15812222bbc1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a3818a23-1d4d-4351-a2a3-52aee8fe6974",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72e28bde-3c8e-46a5-a091-cc5e1bf9703f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4535bf1c-4533-4568-9d32-a7bf117490f8",
"db_currency_id": "dd16015b-551e-469e-8686-2d52d961a511",
"db_language_id": "dcb34477-2244-40b8-aa89-e8f64bb468c1",
"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-29T07:44:51.272618+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.272618+00:00"
},
"marketing_segment_id": "7412b6a6-6f8f-48f9-827c-a66f7bdebb68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62550dd0-ea0d-4e11-a3bc-c9435d8ba884",
"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": "177b9a3f-dfab-4537-95a5-16addf659ab6",
"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": "7dff7621-de56-472d-aef7-d2140d2746e6",
"db_country_code": "sample string 28",
"feelist_id": "06f325fd-58ff-47c6-afe9-35da97067868",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c23fb195-009f-46a1-8afd-e135438e0a24",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "baebf50e-1870-46e3-8b57-bad94f005de1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T07:44:51.272618+00:00",
"db_currency_id": "dee62e9c-638b-4c34-bdc5-e3ef400fd939",
"db_currency_code": "sample string 10"
},
"company_type_id": "e38cdaef-0fce-4ca2-8f0e-251e99305e37",
"company_type_name": "sample string 32",
"company_type": {
"id": "a20e4db6-e461-450e-af01-067872b36cfd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be23bb38-5ec0-4eb6-9d0a-0b6e8d271156",
"sales_organization_code": "sample string 5"
},
"db_language_id": "094a1662-e249-4925-ab37-b11b8d1537bd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "93a4109c-acd1-4bca-b7ae-725f9420ba97",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "84f0c4eb-372c-43a2-a075-9a935304bf70",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "01d10795-50bb-48cd-8d2d-5b8109efae87",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T07:44:51.272618+00:00"
},
"company_sector_id": "da431d75-ccf9-49a9-a5da-e52eed89ae6e",
"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": "1ef63350-87e1-4b62-ae6d-6dcb119ab718",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a4db250-0aab-4e02-9289-c328fb1ec500",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7587bd3-63e4-412c-b394-aec887b44eca",
"account_manager_user_code": "sample string 56",
"company_status_id": "d6242caf-f344-4780-96e6-c0b57c3bcb16",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T07:44:51.272618+00:00",
"id2": 60
},
"db_language_id": "4e90b39b-8fa7-42c4-86f8-8a69277efcf7",
"db_language_code": "sample string 7",
"db_title_id": "67ed8755-094a-4c09-8e08-18bd70346bba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T07:44:51.272618+00:00",
"create_date": "2026-08-29T07:44:51.272618+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-29T07:44:51.272618+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.272618+00:00",
"id2": 22
}