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": "873359c9-0821-45ed-b5b4-e151511d13c6",
"_parent_id": "5613b755-692a-4099-95b9-d70e01a54702",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0d005bab-b483-42fa-9e2d-b00b1f4b7abf",
"company_id": "d3c2050c-fcf8-4c69-9a37-1b021c203489",
"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": "35104edb-e9ce-4388-9ed9-bf5793dce547",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c36b1cb5-bbab-48d9-8c13-0ce1a27efe6f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "11985dc8-19c8-429e-a34f-0f50df6e8d05",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b775fa72-bf30-4778-b18e-bb632dd8271f",
"company_code": "sample string 5",
"company": {
"id": "b3c35056-471d-47b9-b9e1-25c6488c348a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-30T18:54:35.8023865+00:00",
"sales_territory_id": "733c104a-256c-4d6f-a359-438eb5efde27",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6fbcaab5-62da-412d-b9fc-c3ef41175dbd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b3583e3-fa04-4808-8dfc-477a2744372d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d5201e2-3a7b-46e0-8ead-11e364c31cda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a834687e-9228-423e-b78f-b762f8793119",
"db_currency_id": "5dd0af7d-0d37-4d07-9fed-87db4baf306a",
"db_language_id": "8e8487a4-ac30-4970-8570-44aec428f5c3",
"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-30T18:54:35.8023865+00:00"
},
"modified_dateutc": "2025-12-30T18:54:35.8023865+00:00"
},
"marketing_segment_id": "977fe350-5406-463e-9edb-09725b4f5e53",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f07bf5b3-aa5f-468b-bfe1-e3c0bed64d19",
"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": "8836e23d-c9b9-48f8-aa33-b1bf2b03ec60",
"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": "943bdfe2-2005-4868-8518-504e95472792",
"db_country_code": "sample string 28",
"feelist_id": "52e5a9d0-481f-4391-8b4d-378b96261cba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cc0bbaea-5892-4f14-8bc3-741b48ecc775",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2062289f-95a9-45a0-ada1-14e542e7803d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-30T18:54:35.8023865+00:00",
"db_currency_id": "0f2ce25f-c433-485a-b4b5-c91aa7edc745",
"db_currency_code": "sample string 10"
},
"company_type_id": "c1260f9d-c9fa-4036-825c-79668f182ac1",
"company_type_name": "sample string 32",
"company_type": {
"id": "d8bcac4d-d754-45c7-b943-3ff333fda61b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77736a95-e281-4cff-83df-c76466c2d023",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c4f43d38-2b62-421b-bf93-687fbf7b2d25",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "69161976-9553-4af6-a500-663fd5c32783",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5911c260-4393-4987-93b8-14b2756d311a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1a03916d-4166-47b1-b61b-685b2648794e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-30T18:54:35.8023865+00:00"
},
"company_sector_id": "c093bcc2-085b-43bf-a6ac-6735d00a095a",
"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": "1626e0b3-830b-414c-aab4-bba792bcf8d2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e8b4f045-dda0-4c3a-b886-412b73e46229",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "379e251c-665a-4df1-9ede-a014273e81c9",
"account_manager_user_code": "sample string 56",
"company_status_id": "16d386da-8122-4a61-8735-32144efa2b55",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-30T18:54:35.8023865+00:00",
"id2": 60
},
"db_language_id": "23519d95-6976-4066-b373-202328838af2",
"db_language_code": "sample string 7",
"db_title_id": "0631c969-ea74-46f5-94a4-26626e240a5d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-30T18:54:35.8023865+00:00",
"create_date": "2025-12-30T18:54:35.8023865+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-30T18:54:35.8023865+00:00"
},
"modified_dateutc": "2025-12-30T18:54:35.8023865+00:00",
"id2": 22
}