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": "1a03b5f6-eb56-47ae-a06b-161cd1b95bf1",
"_parent_id": "80280524-1e4f-4c54-b761-15285b46b7c4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a6575059-32c8-4dfd-834e-c94eaea64527",
"company_id": "efe6d6b6-33b4-4720-a773-f99475c5ada9",
"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": "2825251c-71ef-4db2-8339-2ec635ed9d91",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5374e954-4db2-4138-bd82-47b8f82ee05e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3e4e6ccf-a82b-4c91-89b8-6648a8a08769",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a7ef798e-2d6d-4b26-8b5f-e581a4d35223",
"company_code": "sample string 5",
"company": {
"id": "2a065d5c-4bd6-460f-bbc4-efd402de63ec",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:32:55.931346+00:00",
"sales_territory_id": "950115f9-84ac-453b-8c56-a3e0ff78fa07",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5c63a376-ec72-4c06-8d76-7c8e608e35ab",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30a8a2b0-a86b-4de4-81c4-ebd0652f0d9a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e08a9606-7e55-457e-bd06-295dbd5ef864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756eaa88-5040-43bd-b035-c02d00418bbd",
"db_currency_id": "74e0e721-1b63-4a6e-a203-e9af03e98299",
"db_language_id": "ea70f6de-11f4-438e-a703-2a84aa8fd526",
"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-09-04T14:32:55.931346+00:00"
},
"modified_dateutc": "2025-09-04T14:32:55.931346+00:00"
},
"marketing_segment_id": "96cbc948-b4ec-4cfd-92bc-977ab947a880",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2f026e11-b4c9-475e-a008-4ce8cad50962",
"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": "8bac86e3-cdf2-488e-a039-d88c9e8471b2",
"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": "f0100337-5cad-49b3-8b98-9fed9f86299c",
"db_country_code": "sample string 28",
"feelist_id": "e868763d-d4cd-4827-b787-0be38bc48035",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7feff538-3cc2-4853-9f4a-ad78e5ae5473",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "19039d82-97a3-41f0-bd45-0089ae053eb2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:32:55.931346+00:00",
"db_currency_id": "d1422daf-ea73-44db-a7bf-3cbb819e7258",
"db_currency_code": "sample string 10"
},
"company_type_id": "83b2bf6c-0622-4ee0-ac5b-bac96adfec7a",
"company_type_name": "sample string 32",
"company_type": {
"id": "ca5bb625-0f86-4378-af4e-a1171acb958d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58d69eef-18dd-437c-ba7c-85a85f65b2e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fb49b6d4-d155-4d3c-9ef4-7502e02ca524",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8b3bca45-ccf5-4f5f-8ea2-5ac05fbe7e79",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f4474bd3-4ba0-4a12-9963-361f1f499024",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ae03fd4-b75a-4fb8-ab87-399d63640e0c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:32:55.931346+00:00"
},
"company_sector_id": "a4c3577a-c360-4ae5-8181-18eb5532ace2",
"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": "768cced2-6c69-4fc5-b529-2d24daea624a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "520b591b-b844-42b8-a4a2-fac2339e6cdc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6db8e4a6-79e6-4d80-aec7-da71501c27dc",
"account_manager_user_code": "sample string 56",
"company_status_id": "d0c4ddd8-f692-47f6-87b3-17a4f4984c4c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:32:55.931346+00:00",
"id2": 60
},
"db_language_id": "265d2528-2e2c-4b86-a85e-648009ff274c",
"db_language_code": "sample string 7",
"db_title_id": "0673d5dd-ab60-455f-89ff-395a4f7ade66",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:32:55.931346+00:00",
"create_date": "2025-09-04T14:32:55.931346+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-09-04T14:32:55.931346+00:00"
},
"modified_dateutc": "2025-09-04T14:32:55.931346+00:00",
"id2": 22
}