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": "4088d85e-4d6d-4215-9364-6c7f33106655",
"_parent_id": "61de7ee1-676f-4c3b-bf0a-5f254dcc9b08",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3b1df66c-8ac2-4f2e-8ba4-d2811b50015c",
"company_id": "1d2a467f-066e-4db3-9cb4-9c679e62fd56",
"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": "c8779a91-b2d6-4282-a84d-6b91f0da93e2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "85d3aa52-15e5-491a-9165-a175b5344584",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8fd5d039-8e81-4a4a-bdc0-10a92bace860",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f9aa6b18-7ea1-4f99-bb16-86e1728dd1bf",
"company_code": "sample string 5",
"company": {
"id": "8109973d-e63c-4f4f-874a-c3e966fc8b45",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-07T02:58:04.1592981+00:00",
"sales_territory_id": "ea0e9351-7606-4b69-98b6-ae2d6eb48659",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8a24e7a-62e6-45cb-bb50-6ee3c3e56a9c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b6246ba-a38d-4c39-bc94-73cfa466192c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb2cadf5-2dc0-4ec2-b4df-df75b713e6c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7cfde1d4-a942-46d1-b6ac-9d60b8294876",
"db_currency_id": "9f180a9f-c022-448c-9303-c9b025144c8d",
"db_language_id": "ea107827-186e-4755-9741-af0995321e2c",
"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-07T02:58:04.177946+00:00"
},
"modified_dateutc": "2026-11-07T02:58:04.177946+00:00"
},
"marketing_segment_id": "7b2383df-fac6-47e3-8bdf-021463000e69",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f37be6d4-17fd-41ce-9c09-21cb3a8e0aed",
"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": "b02cdbb3-35ef-4737-9add-8e7594000657",
"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": "14a3ecd3-7ded-4dc1-9170-b69708f99557",
"db_country_code": "sample string 28",
"feelist_id": "c1743ad5-071b-49c9-ba36-11b4b792f254",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a6e83edb-5b58-4ca2-881e-09dc84aff257",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0408e695-b8fc-4eab-a6ed-1ab0bdd71325",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-07T02:58:04.177946+00:00",
"db_currency_id": "fb75cd95-cfda-4a0c-802b-4b2cf39c1273",
"db_currency_code": "sample string 10"
},
"company_type_id": "ed4b4823-0d21-4e86-a495-566b59c50161",
"company_type_name": "sample string 32",
"company_type": {
"id": "cf15cf04-0ed0-4162-b1bc-ae25d897595e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c03e3d5-ec16-4417-be71-6303ee2cd8f3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c06605c3-fdeb-4846-8367-9535fe7fdb85",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "51612649-58ad-4089-bac7-62994d8148a6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e22c4a04-4223-40f9-b812-d8a2c74f6df4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3fcbfdc1-7017-4580-a2ba-ef4b91820b91",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-07T02:58:04.177946+00:00"
},
"company_sector_id": "87a25c8f-2824-49a1-870a-4ca4d2539782",
"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": "6fd06b08-337b-4233-8c6a-168c6efa658f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1727a110-8092-46f3-9d79-0bd2499b9137",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1c2d505-d444-42ac-9eb6-0e7759a934bf",
"account_manager_user_code": "sample string 56",
"company_status_id": "e5d47178-aaa0-4d99-9894-3cebd041b1fb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-07T02:58:04.177946+00:00",
"id2": 60
},
"db_language_id": "b3c8e848-6c48-4011-824d-9aeff6426eb0",
"db_language_code": "sample string 7",
"db_title_id": "4c4c1f64-9c34-454f-901d-e5d2c7ac5c37",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-07T02:58:04.177946+00:00",
"create_date": "2026-11-07T02:58:04.177946+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-07T02:58:04.177946+00:00"
},
"modified_dateutc": "2026-11-07T02:58:04.177946+00:00",
"id2": 22
}