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": "6844df84-7753-4ffb-bb64-808ec2d73a67",
"_parent_id": "5efd92f0-3121-4ef4-9236-05d79f1df9d6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c03c0c89-1792-438f-9323-ccbc03875c6b",
"company_id": "325e504e-b1a4-4b9c-a8de-aae1e529b1b2",
"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": "dd8334d7-c47f-4e0d-879c-12e66d89d587",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9c86ae7c-f314-498b-8e4c-6c42101a5bb2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9ac56a27-92f5-4719-a3c4-3d798f5fe0ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b21ac96d-cefc-44a3-bb86-4b6959e2ed7f",
"company_code": "sample string 5",
"company": {
"id": "d733050d-b12a-40a2-bc98-8481258bbedc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T02:07:03.1901709+00:00",
"sales_territory_id": "52502b2c-1035-4405-8b1d-b5c2c4e3659e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2b780290-1b46-4bf6-b62e-f1719d1d3923",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e8ea82b-67b6-4b0a-8074-48ccfeb177ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "faa1b673-f65b-4500-9f6a-c20606126bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d628458-7b01-4398-978d-fdc18ca3bcea",
"db_currency_id": "22013846-ae7f-4a74-801a-1351886b4486",
"db_language_id": "86087b02-effd-463c-9417-91df3d262ad7",
"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-07-23T02:07:03.1901709+00:00"
},
"modified_dateutc": "2026-07-23T02:07:03.1901709+00:00"
},
"marketing_segment_id": "0697a6f5-f2ee-416d-acfb-04f39c0f9d56",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9cea3252-859c-4a71-a503-76be29cc46a1",
"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": "0e8d4be3-586c-4cad-8adf-f1a00637b9db",
"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": "7518fab9-f45d-432d-814c-5b4d3eb7b83b",
"db_country_code": "sample string 28",
"feelist_id": "6d13dcfe-0b9c-44b3-a1be-6cba218e7650",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08adf36c-6801-4813-8655-8a5c942fe34f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "08a91075-3c0a-4fac-86c9-71d7a93416b0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T02:07:03.1901709+00:00",
"db_currency_id": "3a936438-a273-45ef-92cb-48fb447281c6",
"db_currency_code": "sample string 10"
},
"company_type_id": "0a64e2a2-c493-4429-85d3-ff13c3697357",
"company_type_name": "sample string 32",
"company_type": {
"id": "0cc836d7-560c-40f6-8e71-63e115aba174",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "89590f1d-8a3e-4011-a858-a48ab89f4021",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bca31468-6da4-4bc5-a93e-55737f818a5c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f31ef5e-aeaa-4488-af50-a6df7da12d78",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "13fd6b2e-08d4-43b1-a8fb-9e7328c57f55",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f56a84fa-c180-4776-8cc6-7cf9c8da9d0f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T02:07:03.1901709+00:00"
},
"company_sector_id": "16bf0f7a-1ca2-44b3-bc2c-ca56ddfd503c",
"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": "5f672d1b-6a42-44c4-9100-75d4b81b2b22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4c49c9cd-1748-470e-aa5d-6b1350bb99bc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "09be1bfe-da2c-429e-99f7-d1e497a6f430",
"account_manager_user_code": "sample string 56",
"company_status_id": "cf4647c2-19dc-439d-9918-8cedf61fdf0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T02:07:03.1901709+00:00",
"id2": 60
},
"db_language_id": "bb9c7c97-ea89-4b23-ad48-c6ed8d1510ee",
"db_language_code": "sample string 7",
"db_title_id": "8ec07eb4-412a-47ec-9dd9-d5ed105811fe",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T02:07:03.1901709+00:00",
"create_date": "2026-07-23T02:07:03.1901709+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-07-23T02:07:03.1901709+00:00"
},
"modified_dateutc": "2026-07-23T02:07:03.1901709+00:00",
"id2": 22
}