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": "101b795e-f731-42b3-99a2-be9562f85130",
"_parent_id": "b8aae1d8-38ef-4663-928d-88a0134c026c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fc76d04d-d97c-473e-a110-369ee2f80b54",
"company_id": "fcd68694-ca57-41b3-a841-357a6e003a91",
"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": "7b039685-778b-4b9f-a439-cddc6472e814",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bbf4f010-a931-49e9-9cce-f98f23d77b83",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9ed04cc3-8b06-414d-9b35-7f4129af2572",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a6610bf-368e-4b6f-b899-cf82f3164b0f",
"company_code": "sample string 5",
"company": {
"id": "1c2150a6-0339-43be-947d-a319f3e2d8a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-26T09:49:22.6884901+00:00",
"sales_territory_id": "0b8f78f0-9a56-4d93-8829-7de84bbb266a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d730a56b-8bb2-4292-949c-7a46fcdf2bda",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5110da5b-b98f-49b9-a006-42db5c035c60",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30656337-0c68-420d-a95f-efe6748584eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bc085455-a433-4cd5-a39f-81a47eabf678",
"db_currency_id": "c53388b3-ec28-43dd-b9e8-2ed4a3b5234a",
"db_language_id": "56045d61-21c0-4a04-812f-966b6843d78e",
"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-26T09:49:22.6884901+00:00"
},
"modified_dateutc": "2026-07-26T09:49:22.6884901+00:00"
},
"marketing_segment_id": "d911e35a-a8cd-4517-9af0-903007f4a1da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "04186108-f646-4c3d-94ad-6f98f4ba3d56",
"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": "83862849-296f-4cfa-ad92-bf56564f21d4",
"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": "da568599-692e-4e49-8cf7-f0f151c614da",
"db_country_code": "sample string 28",
"feelist_id": "bbf0e1e4-f38c-467f-a8e7-7e446ff8a43d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "661a1f03-0d81-489d-801e-851708613c33",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d02b5cda-688d-491d-b158-cf039f429758",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-26T09:49:22.6884901+00:00",
"db_currency_id": "979f07ee-79f0-40e3-8cd3-d21bca054276",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf698543-0458-4414-bce0-0c563b878401",
"company_type_name": "sample string 32",
"company_type": {
"id": "b3b359c7-a84c-4c51-872c-a10e65e3452e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8f428e3b-5e9b-4611-8254-1bba5c1de38f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3a896267-6514-4379-9771-a13188402ba8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4888a0de-acfd-4bcb-bd15-d0600e29ca98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "def45dc5-a411-44d5-a977-7f5591677385",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5484ed28-f9bd-4582-be0d-0d73f63e2be7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-26T09:49:22.6884901+00:00"
},
"company_sector_id": "04d5dd34-1068-4117-95e7-8df3b20c52e5",
"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": "17773909-0638-48e2-a54b-a95929bce898",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fda80ff2-069f-4f81-9ee4-3efbeb467471",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fc8de27d-e92e-4db7-beb3-4b0edb9d420b",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f73c1e8-491b-4d01-a5bf-1e601ac822fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-26T09:49:22.6884901+00:00",
"id2": 60
},
"db_language_id": "64580ea7-bf57-45a9-b4ac-376686c2e9b8",
"db_language_code": "sample string 7",
"db_title_id": "f05719e2-1c11-412e-a10a-bccc6c438e63",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-26T09:49:22.6884901+00:00",
"create_date": "2026-07-26T09:49:22.6884901+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-26T09:49:22.6884901+00:00"
},
"modified_dateutc": "2026-07-26T09:49:22.6884901+00:00",
"id2": 22
}