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": "07031be6-200b-4dde-a39b-aea50a06d620",
"_parent_id": "b8a1bf60-ec2e-40be-8395-72fe763b039d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "672388f3-2825-4eec-b822-f03e3b0fbf2f",
"company_id": "9ac4c435-b635-48f2-965c-ed168da7d092",
"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": "82dc0745-e20e-44f6-bfb8-ba02acc72644",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e3bed2ff-c210-4536-8da1-269ad7e9f606",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a5eeab44-48ef-4d86-8885-4409b5a474d9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c2455e4c-b0c1-4e54-9442-a958777dfdae",
"company_code": "sample string 5",
"company": {
"id": "bcabd8e3-5272-456a-b7c6-471725456d77",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-07T15:22:29.5773435+00:00",
"sales_territory_id": "09e2f1c5-20e1-488f-b7d6-1a662fd86aed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "867ea5a9-e36b-4886-bfa7-c4eef4305852",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f07a8c6-1a2b-4823-b8c1-7ee5bbb21145",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "abf95544-5ed4-4885-9fe5-af069d295522",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "382db1c5-7d46-488c-b441-bea42d8f3eab",
"db_currency_id": "0c3af702-7788-4ae2-99b4-18c5a5ae159f",
"db_language_id": "6a9467e7-5ce3-4d60-8a36-cb9c2e9dea58",
"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-08-07T15:22:29.5773435+00:00"
},
"modified_dateutc": "2026-08-07T15:22:29.5773435+00:00"
},
"marketing_segment_id": "0954f25e-97f3-48fa-aaf6-f26403ae1f9d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f19c46bb-69c9-47f1-92b0-bc8a23fc141d",
"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": "a39a90ac-ca14-4e27-978a-e8f1094cc77c",
"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": "d0b5df38-2cfc-476d-8157-87a23ae64c18",
"db_country_code": "sample string 28",
"feelist_id": "32f35f21-aaae-40f6-a02f-13b7a86dce0a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08048561-10da-4990-a6fc-3d18bfe80acc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6cfc44fa-558d-4a67-884a-581dedd7f274",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-07T15:22:29.5773435+00:00",
"db_currency_id": "5b775a62-4cbb-45ba-825e-11e72a438ee4",
"db_currency_code": "sample string 10"
},
"company_type_id": "e5888542-8dd3-4f45-9219-ba1128076a10",
"company_type_name": "sample string 32",
"company_type": {
"id": "e3c7a170-35d8-4717-8079-a53280302bd1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b459659-aee5-4ebb-a934-8bdb65659fe8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2b99f790-8e27-4a77-b3ce-19a52d56f850",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4375e968-1bfb-44da-9f45-33d56303b2df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37910baa-8ee9-447a-93e4-b734eb5066e1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "79fc8918-80b0-493e-90b7-638c3f6352b5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-07T15:22:29.5773435+00:00"
},
"company_sector_id": "e8bd0515-c9bd-4ae5-991a-8a3cd29f2b75",
"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": "075d5d14-693a-411e-a01a-fbe583a72aa0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7eff8244-5a28-42b5-a3e3-f3a918c12760",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8a965904-d749-4896-a7df-7d8616c7b032",
"account_manager_user_code": "sample string 56",
"company_status_id": "63f1dfa1-950a-4ee6-a65f-8ce6b5b88646",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-07T15:22:29.5773435+00:00",
"id2": 60
},
"db_language_id": "4189fc61-8db1-41ad-b465-083053bbfa04",
"db_language_code": "sample string 7",
"db_title_id": "d3c0d59e-3a5f-4c39-96f5-187b99577f00",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-07T15:22:29.5773435+00:00",
"create_date": "2026-08-07T15:22:29.5773435+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-08-07T15:22:29.5773435+00:00"
},
"modified_dateutc": "2026-08-07T15:22:29.5773435+00:00",
"id2": 22
}