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": "b3747b59-f1ed-4c09-845b-f36a726c3633",
"_parent_id": "412f862d-53a1-4486-94c6-3bbeec2d5e92",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a9d6ecb7-55c9-49c1-b1ee-59e4fddbef5c",
"company_id": "0347b22b-a8a9-47ae-a11e-2c75a1b832d0",
"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": "ffd54dc7-ae7a-496c-a9ef-8368c40aabf3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0f8d27fe-4b26-4e9e-b4f9-6958c0f74e33",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7c1b5463-3e5c-4010-b70c-8be1be73afe0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2aad472b-3730-462d-af29-6c641841519e",
"company_code": "sample string 5",
"company": {
"id": "8ab89e86-cd59-482f-9e96-14963011da46",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-02T17:39:48.5340366+00:00",
"sales_territory_id": "d96af593-81f8-41c0-a474-23ab985ba9db",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9248c368-2eb1-489c-ac07-3f2c1efa8809",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0fcf80b-0f35-4ab2-aa96-555378e45702",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd5358e3-b0eb-4605-a4a5-d9bdca9e4cd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3318afd4-edb3-4b95-b353-9df1cb651202",
"db_currency_id": "d607d548-9f99-4a1b-bcf4-ee0845b99ba1",
"db_language_id": "7b6a535b-8ec0-44cb-bf2a-7acc78796a2b",
"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-02T17:39:48.5340366+00:00"
},
"modified_dateutc": "2026-10-02T17:39:48.5340366+00:00"
},
"marketing_segment_id": "3ddd5b31-b5b8-4a7c-b146-4b2eb03fb19a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0c1ccca-44e2-43ac-a0f3-256c81debd29",
"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": "702cbe2c-b1c7-4bb3-a2cd-d478822b5baa",
"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": "4cbc2100-1e05-4ebb-b8d5-40cd4983ec7e",
"db_country_code": "sample string 28",
"feelist_id": "fe0d3322-6dbe-41b3-8735-7bdf9af17315",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a05bd909-2d90-41f1-93f3-30bd4f334363",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a4f87c86-1d5a-4dff-9c0b-63448f45adaa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-02T17:39:48.5448682+00:00",
"db_currency_id": "df66357c-5796-4864-80fe-962d1b154683",
"db_currency_code": "sample string 10"
},
"company_type_id": "b656b3ce-f2c9-4bb1-a24a-27e73548ae81",
"company_type_name": "sample string 32",
"company_type": {
"id": "8df60d45-f0e9-4b1c-9f26-8423efdc4391",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9766bfb-1f19-4412-b624-45a29d235853",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6ddb78a-f52f-4910-8a3e-dd3cfac79091",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "57dc728b-15a9-44db-8246-4985f43dab84",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a376d69d-46b9-4f8b-861e-39d1838fec1d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "965ef97d-f3ca-4ed5-8eaa-da515392d9ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-02T17:39:48.5448682+00:00"
},
"company_sector_id": "51c315d0-8b1b-430f-bace-071f84b6b18f",
"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": "8f4004af-8350-4b05-b5c6-061372c64958",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bfdaa941-14ee-4838-b94b-4151da274610",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e47ef06c-72f8-4764-a532-69dcab6a11e1",
"account_manager_user_code": "sample string 56",
"company_status_id": "d1c660f5-5706-4ff1-83c6-aad1519f6b4c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-02T17:39:48.5448682+00:00",
"id2": 60
},
"db_language_id": "f6e97e6b-077b-4c77-86db-c140e64e92bd",
"db_language_code": "sample string 7",
"db_title_id": "d243dc00-3204-419f-89ee-ef8de7d884ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-02T17:39:48.5448682+00:00",
"create_date": "2026-10-02T17:39:48.5448682+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-02T17:39:48.5448682+00:00"
},
"modified_dateutc": "2026-10-02T17:39:48.5448682+00:00",
"id2": 22
}