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": "0e402c52-4f2d-4179-97a2-a1758839c1af",
"_parent_id": "e19a2991-f074-44a9-a7a2-604b8b9ce9e3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e4461821-632a-4799-a063-a540daf0b517",
"company_id": "9068c6b3-5f74-4850-8b49-1614f726a68f",
"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": "4cee1b8d-14d3-41bb-97e3-bdbe2941daee",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "fdeeabb7-158e-42f6-9c98-974d129e2e50",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "21b72f03-de86-4fd7-a874-170cd516f2d6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "76140ab8-68e7-4730-91bf-dd7f85fa18ac",
"company_code": "sample string 5",
"company": {
"id": "0bbec418-7209-4f77-808f-f618af964c61",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:52.5850974+00:00",
"sales_territory_id": "86e9eaee-ac94-4510-8528-0c536ecd6c6f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "850d9276-6b1e-4198-9dda-637dfe012545",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4b1f071-64b0-4723-8185-eb4eb2cbf4da",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff33d85f-caf2-4760-981b-a1a044672112",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a683d30f-40bb-4c93-a997-5d8eb1b4889b",
"db_currency_id": "01bb4ee3-8120-45be-8c8f-bb079a48f94f",
"db_language_id": "d70e3623-4a17-4aa4-a737-be2e2103703c",
"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-06-02T03:48:52.5850974+00:00"
},
"modified_dateutc": "2026-06-02T03:48:52.5850974+00:00"
},
"marketing_segment_id": "3799ffc0-f7aa-4913-9492-af76354e9c49",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "80bb2254-3ed1-40ae-b196-bbc70026d86d",
"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": "55ee8b64-2d41-43c8-a6ba-7aae906b11fb",
"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": "20406b3d-ecb7-432e-9965-494a401c7fff",
"db_country_code": "sample string 28",
"feelist_id": "7d81fc98-0ed1-4cf8-9787-88e9d55910d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "91ea8c9d-4fc3-41f3-996d-bfbd72a67cb9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "87c0adbe-c2f7-451c-9888-af321a6e2c69",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:52.5850974+00:00",
"db_currency_id": "82926f0d-3226-42eb-ae44-989e3e7a05bf",
"db_currency_code": "sample string 10"
},
"company_type_id": "4bbd05b6-d8c8-4611-af1f-8bf1193a76b2",
"company_type_name": "sample string 32",
"company_type": {
"id": "6c111152-e488-4b83-9cb3-f22952b1a5e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d768e28-aa38-4ae3-94d0-39e4f16746c5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "196f36c7-6c7c-43aa-a8f9-ef9e0a9071ae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b53039b8-1ff3-48a7-a772-8f1acf63fbbf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2bb0920-f1f0-4ab4-8214-5ce5b68bf43b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "efb50d96-7b1d-46fe-b7d7-4f9941be9014",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:52.5850974+00:00"
},
"company_sector_id": "6551c9dc-ebec-4ed0-bde0-4ea56fcf04c5",
"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": "6b894689-eec9-488d-8b00-f1315558f4d4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "33009008-e5fe-48cd-8dee-5a31d8369c94",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "decd2ede-9e74-43a0-b43b-b77c016bdbda",
"account_manager_user_code": "sample string 56",
"company_status_id": "ba776583-102e-4d8e-813a-174095da6cdf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:52.5850974+00:00",
"id2": 60
},
"db_language_id": "6fde2075-b123-4e7a-805a-85e1175e513f",
"db_language_code": "sample string 7",
"db_title_id": "7fd2324e-1a16-4c3d-be0d-c11d3877ae91",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:52.5850974+00:00",
"create_date": "2026-06-02T03:48:52.5850974+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-06-02T03:48:52.5850974+00:00"
},
"modified_dateutc": "2026-06-02T03:48:52.5850974+00:00",
"id2": 22
}