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": "8daf663a-5781-4eac-ba5c-e50f6bc7a240",
"_parent_id": "3bea4ea7-78df-4f41-aeb9-337a68ec3dd1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d42c1978-90a5-4123-80df-a440a65ebf01",
"company_id": "776644b2-1b00-4ef1-8cbe-6ccec091f51d",
"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": "0ca17ab3-3416-4f0b-965e-a220fbe1f772",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f7ae2d81-b115-4820-a6f9-4375afd1a1c1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5847a269-eaa7-4441-8b58-ae0642eedb2a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2dd3f2b5-3d1c-4eae-98f5-78c9800c6467",
"company_code": "sample string 5",
"company": {
"id": "e282227a-94da-47f8-85e5-6abc48235fdd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T09:16:28.8242302+00:00",
"sales_territory_id": "8ddefb12-ae2f-469b-91ed-a6f58ec8a7cd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd82241e-5034-4ecf-b1bf-02ded3ae0254",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24bc1217-0fb3-4af9-badd-bbb532287bdf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd2bae9f-8b74-4c3c-8a6c-82300a7de710",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d88e58d3-6454-4e4c-9fe8-88cccf82088b",
"db_currency_id": "eb58924a-d11b-4dad-ba24-936ff0e4b455",
"db_language_id": "4b79ec95-aebc-40ed-b445-ba74860cdeae",
"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-23T09:16:28.8242302+00:00"
},
"modified_dateutc": "2026-07-23T09:16:28.8242302+00:00"
},
"marketing_segment_id": "cda5695e-727d-4dea-b196-7839bfb512fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "488ab552-d656-4479-bc78-b6393d7e100b",
"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": "8774ad89-54d0-4bb0-bc9a-b2650cbe94ca",
"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": "bdee52a3-67da-4055-9ffc-59531c611168",
"db_country_code": "sample string 28",
"feelist_id": "a9463d86-940a-4a14-9622-f8e483b4627a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b4305f57-f520-4466-8bf7-4b618d3842c0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "412bf4b0-41c9-4ec4-b6c1-9c87906df024",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T09:16:28.8242302+00:00",
"db_currency_id": "ce4ea0a4-736b-4d07-abc5-6efd01dd5d05",
"db_currency_code": "sample string 10"
},
"company_type_id": "2bc69ac9-bde4-4c2c-ae35-06b22061f88a",
"company_type_name": "sample string 32",
"company_type": {
"id": "393f5212-8810-4d5d-a581-6aeab88ee609",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18189a3f-a379-4392-908b-e2f835b6ca35",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f716ba44-2063-4257-87a6-c3e1e2e3778d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "31dc44d3-b866-4004-b30e-5cb6729ce0bf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6644d8c1-7621-4a01-93ee-3cd5ebc7ee14",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cb663a45-92f1-43eb-ada4-e7b3ae0c8abf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T09:16:28.8242302+00:00"
},
"company_sector_id": "c1118271-77b2-4a99-ac71-89fa0d0210e8",
"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": "3f9ce115-1e35-41b7-bf83-f1041a05a6eb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "42649916-00dc-4d44-84dc-a46bfe23c673",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6d305699-e1ac-427e-bd71-90b29278485d",
"account_manager_user_code": "sample string 56",
"company_status_id": "5f6b09bf-b1b3-435b-a710-1bee743c73b6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T09:16:28.8242302+00:00",
"id2": 60
},
"db_language_id": "d3f736a0-e26a-4f7e-9b67-561e2f734aa5",
"db_language_code": "sample string 7",
"db_title_id": "312c250e-7222-4f7a-906c-21eaacec0724",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T09:16:28.8242302+00:00",
"create_date": "2026-07-23T09:16:28.8242302+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-23T09:16:28.8242302+00:00"
},
"modified_dateutc": "2026-07-23T09:16:28.8242302+00:00",
"id2": 22
}