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": "61d2ab9a-dbfa-4edb-9550-dba834bd671d",
"_parent_id": "343c4edd-e032-4a6c-924f-3b9cd661b92d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a3c3186f-efa0-41b7-b989-78be142335cf",
"company_id": "ecd9a319-9b9b-400a-9eb9-583d79480f98",
"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": "5df2c76e-a570-495d-ae14-b7956cea6268",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6784dfa1-be90-4487-b48e-6cab228b6e08",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9ac0de37-c8c3-43fc-8f45-68cd144536a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e030078c-1bbf-4757-aaec-ade07865b000",
"company_code": "sample string 5",
"company": {
"id": "31ecd22c-8741-4dee-ad5f-fc5106668de8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T11:26:08.7931122+00:00",
"sales_territory_id": "a8c1e353-60e4-4c8d-a9ce-6821bbdaaf00",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "39a5bc9e-f50c-4993-89fd-2955d0e138db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0c46c5a-41e5-4aee-b259-a75e05a01122",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed0e4770-bfa1-4009-ba32-05b0126ddda3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8da1b823-4f25-4e5a-bbb2-191c4b5872ff",
"db_currency_id": "0e9357f2-c492-4f73-b569-816f8faadfdc",
"db_language_id": "a656044c-c51f-4e76-bd1f-62d5737531e5",
"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-12-16T11:26:08.7931122+00:00"
},
"modified_dateutc": "2025-12-16T11:26:08.7931122+00:00"
},
"marketing_segment_id": "3b430e34-aec1-4d25-bb34-b9f701d2df05",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cbb5ec6d-2d14-4f24-850c-9fbec935b05e",
"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": "cfbc4e20-bbed-4c8a-8b48-a8144fb71922",
"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": "2fcb47cf-4c3d-40fc-983f-85020b124487",
"db_country_code": "sample string 28",
"feelist_id": "b69c0de2-25a2-474e-a73e-2f6d54009bcd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75e2ab57-b637-4df0-9b94-18f45f9eb6dc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c4cce30b-a5cb-472d-8a4f-664d06a00108",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T11:26:08.7931122+00:00",
"db_currency_id": "64e5c872-5b20-4343-b47d-9a37b7030c4e",
"db_currency_code": "sample string 10"
},
"company_type_id": "df8e017d-c2b4-4efd-bece-ceb2aa230708",
"company_type_name": "sample string 32",
"company_type": {
"id": "20285e50-9c43-4d5d-85e4-46204380a4aa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77ce23bd-3711-4f9a-92a0-08d30bb8620d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b8b53ab-327c-4fd6-a669-1be564fff257",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "647a0849-ee94-480f-b917-aeac5269ba10",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0c1a78b-763a-4ff2-8af1-e3a568615380",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b80d3eb7-ad4d-470f-a16e-c38e265531f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T11:26:08.7931122+00:00"
},
"company_sector_id": "b6820f8f-7a4b-4a05-a744-e0986959ae6e",
"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": "424868f2-665a-4bc4-850a-135115bc1e18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "53ff7112-50fd-4ef9-aae5-c41c207fde40",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0486ee9e-d4a4-4f79-9b92-363089f1ae7e",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb7d8c4b-e26d-4ab0-9732-d805e11e6c64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T11:26:08.7931122+00:00",
"id2": 60
},
"db_language_id": "474271a6-4c17-4ae6-8ae4-c279c2ca96b3",
"db_language_code": "sample string 7",
"db_title_id": "8bf8d03d-f5c4-47cf-a8c8-4b32823b8a60",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T11:26:08.7931122+00:00",
"create_date": "2025-12-16T11:26:08.7931122+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-12-16T11:26:08.7931122+00:00"
},
"modified_dateutc": "2025-12-16T11:26:08.7931122+00:00",
"id2": 22
}