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": "5ab68a1d-5cc3-4462-8427-2aed98f96277",
"_parent_id": "a29330f7-44bd-4077-9b76-6bb00dee692c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "79d8dd84-2993-4944-95a1-ff47e7aaafbb",
"company_id": "da1f47f2-9308-489b-9cfc-df0eb2e5644a",
"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": "ebcba832-dcda-43b7-ad11-7c50b0b913b3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8c738bdb-dd03-402c-a0f2-b5143088e762",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "459467ed-3134-4326-844c-736635872319",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9e325a74-a06c-4c9c-8554-e17d5ab0969c",
"company_code": "sample string 5",
"company": {
"id": "f642f632-5ed7-45bd-99dc-9cfd7fc44b51",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-07T17:24:27.0153567+00:00",
"sales_territory_id": "7a25f573-d3dd-4b5b-88c4-5ca221c2077f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "44b160ad-b443-474a-8e7f-9d11fc1c31eb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb6e67b8-0303-4330-8ad4-f4bae9cafdc6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5a98b88-f7ac-44ad-a5de-7eb4d9f9abb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8017e1e-e306-430f-9cd3-a16c1637200c",
"db_currency_id": "6465e2d2-6cd6-4015-918f-009a6621bcaf",
"db_language_id": "a0e9e156-9294-4dc7-b776-15fe74859a76",
"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": "2025-10-07T17:24:27.0153567+00:00"
},
"modified_dateutc": "2025-10-07T17:24:27.0153567+00:00"
},
"marketing_segment_id": "d4f5c5f4-e72f-4e91-a6ac-9acd487707a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0999c164-6356-4907-8177-99213e65445f",
"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": "11a431f8-5b6e-4c00-a17f-612f08a7c4fa",
"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": "18780a64-91c0-4e69-a59f-d473ac59c3a0",
"db_country_code": "sample string 28",
"feelist_id": "73de1983-335c-4778-bf48-09136a1ab304",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0cf00391-39d2-42aa-9034-85acf3af22b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "454d6c5b-c5c0-4698-b2fa-2f6029526833",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-07T17:24:27.0153567+00:00",
"db_currency_id": "424e89da-94d6-4e93-9433-aa487c98967a",
"db_currency_code": "sample string 10"
},
"company_type_id": "478a8de1-5df9-4eca-a300-4eb82afb1f2a",
"company_type_name": "sample string 32",
"company_type": {
"id": "1c6f1284-587c-492c-a493-ddba3389a728",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8206075a-1600-4e81-822c-756268f6c90f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45c05968-1d74-4889-90b1-1a4b53c31d81",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c31b07cc-9e52-430e-b294-b2c0d3790b33",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1379e4d0-fdb8-4e31-a94e-ffad66e73945",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "adb38e77-56a9-4c1c-a3f8-2c7f4ba74d84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-07T17:24:27.0153567+00:00"
},
"company_sector_id": "463cbc7c-008f-4056-8abe-98a80190204c",
"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": "3b4c9cd8-9bf6-44ae-8478-55c89ed6a870",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "af0271d6-4537-4bf1-8d49-a668ad29804b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "27859a20-86e5-4b1b-b6f5-40b1990ca91e",
"account_manager_user_code": "sample string 56",
"company_status_id": "9620d744-d184-4880-b6d5-5fd50a1c572a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-07T17:24:27.0153567+00:00",
"id2": 60
},
"db_language_id": "2cc4f4c2-3d2f-48ed-a128-1d301765e21f",
"db_language_code": "sample string 7",
"db_title_id": "5aa1f082-a357-4e0e-bdfb-76a62fedc7c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-07T17:24:27.0153567+00:00",
"create_date": "2025-10-07T17:24:27.0153567+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": "2025-10-07T17:24:27.0153567+00:00"
},
"modified_dateutc": "2025-10-07T17:24:27.0153567+00:00",
"id2": 22
}