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": "22d01897-5e94-4bae-bfb3-5a15e11c491c",
"_parent_id": "a8dd1ca7-71aa-430d-b68e-5eaa3b5241d4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8def802c-8080-4ff6-b360-f980e69fe658",
"company_id": "920b2212-0456-468b-a416-9cf1f35e9473",
"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": "ced171db-ba88-47a4-ad86-70bc85499d51",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "456b7b24-81c2-421f-ae10-da592eb3cfd9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a3cf6e2c-c593-4f02-b713-862f5e2dce2f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "496a03d5-e22c-4c10-b381-02062397d4be",
"company_code": "sample string 5",
"company": {
"id": "e751a77c-3311-4721-b545-a3c661db25de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-07T10:06:48.3449935+00:00",
"sales_territory_id": "504769a4-9328-4cac-8555-4dcc7e76dd78",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0f6c603a-22b8-4520-b82f-104c9e415501",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae08ab9e-db24-4f5a-b422-8429e7d53d1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "38d0a4b7-9593-4071-8db4-1e9e7706845c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e15eaf65-3bd0-4779-bc1e-489d81a8aed9",
"db_currency_id": "e079be1c-2648-4ecb-bc33-cc9fb3c024f3",
"db_language_id": "2bbcc9cc-df3c-4c3d-8599-9d6330399d3b",
"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-11-07T10:06:48.3449935+00:00"
},
"modified_dateutc": "2026-11-07T10:06:48.3449935+00:00"
},
"marketing_segment_id": "11b380e4-fc9d-4a3c-a8e1-3097d94ccc11",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "90a9ddc7-7057-4b87-92c3-bb6ac84ac8b8",
"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": "df0cbdac-5652-45be-aad1-9edb1ab72b26",
"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": "0aa23ebd-757e-4f64-bf23-59b2b5f74b27",
"db_country_code": "sample string 28",
"feelist_id": "c17b0f67-a28f-403c-a552-8f508b2d8feb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "07173b1f-acb3-496a-8294-c4fa5165e478",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e9c0c117-7133-429d-b2c5-475a510dbae8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-07T10:06:48.3449935+00:00",
"db_currency_id": "d30320fb-4839-4774-9278-cd5af259e9da",
"db_currency_code": "sample string 10"
},
"company_type_id": "36abccd5-b532-43d7-ba2a-f56020a157e9",
"company_type_name": "sample string 32",
"company_type": {
"id": "e74def80-7adb-4334-a26a-8111cb80a586",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6663c8fc-58a4-4843-b028-55187ea32629",
"sales_organization_code": "sample string 5"
},
"db_language_id": "37771990-fc63-43fc-8ab4-d0089f62cd69",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "97a9dff3-e8a1-4fc4-a1e7-59a28d8bdb6e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "da4a30ce-afb1-4ec5-b14a-125b9ea85ad0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f97792c-48d5-4d0d-b867-326fb4688349",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-07T10:06:48.3449935+00:00"
},
"company_sector_id": "fd5f1836-8a0b-4ed1-a895-48a34845b44b",
"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": "c451e3d8-78d5-423e-9c18-e833eb5c6ae5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5eff494c-8587-4829-ba3d-b59772374ffe",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "028aa17f-7d66-4e91-8f20-b66ecd2fc880",
"account_manager_user_code": "sample string 56",
"company_status_id": "a7109ff9-067b-41c9-97ae-f4fdc38d038b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-07T10:06:48.3559053+00:00",
"id2": 60
},
"db_language_id": "0407cd25-9660-4ab8-b402-e19ffabc0fc3",
"db_language_code": "sample string 7",
"db_title_id": "1a36a85d-0636-409f-9fa8-7a4f7d674632",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-07T10:06:48.3559053+00:00",
"create_date": "2026-11-07T10:06:48.3559053+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-11-07T10:06:48.3559053+00:00"
},
"modified_dateutc": "2026-11-07T10:06:48.3559053+00:00",
"id2": 22
}