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": "ad012f88-8e9b-4e6c-b548-af10b0a485da",
"_parent_id": "0caabe9a-39a2-4248-94b7-be379dce7fe2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5bff5387-8468-4ee9-92fe-c026720f0f6a",
"company_id": "457af53b-fbe2-4bd7-8f1a-37a27bc5ca97",
"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": "e48b5a20-ee89-4b7c-8c9b-e9d0e03f0b0b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7684bcc0-042f-4d36-be6b-4f91718f5cb1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "51afdfff-290b-4b70-aeea-752976b0b090",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "020ad968-21dd-41d7-a02f-cc6402a496c4",
"company_code": "sample string 5",
"company": {
"id": "77cd9a65-d733-4dbb-a256-9e6affa1edc7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-07T03:20:59.815846+00:00",
"sales_territory_id": "778f5be1-33f8-48cf-9468-7703fa0a4ae6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8ba5eaa0-6028-4127-803d-87a5e674490e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd084471-1dd3-43ed-aaca-0d90f5554414",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5bc62f36-1fc3-41e5-be06-e6a88e7f15bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "357e3f71-f5cd-4849-806f-acaa39ad019c",
"db_currency_id": "4d615c4d-dd34-4c6e-9a9f-aa11ede56f1e",
"db_language_id": "53205550-77e7-48e8-914d-fbfa4cc2d361",
"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-03-07T03:20:59.815846+00:00"
},
"modified_dateutc": "2026-03-07T03:20:59.815846+00:00"
},
"marketing_segment_id": "09b162fd-cabe-40ff-836c-4584ea079c71",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4e675c5f-d6e6-41cf-a12c-d772c63ad60c",
"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": "844b9bc9-c49a-43c4-b636-040eecd8543b",
"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": "f2ec11a9-0848-442f-beb8-7ba2e8a5bd35",
"db_country_code": "sample string 28",
"feelist_id": "83fb51f4-0dd7-4043-b5d0-bd8c5583d92a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e636ed15-94af-4bdf-8dbc-94f8322128cb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "29f44707-72c9-475d-a301-a20bddf667ed",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-07T03:20:59.815846+00:00",
"db_currency_id": "446a886e-d5e5-43ae-b452-01e8903e6b12",
"db_currency_code": "sample string 10"
},
"company_type_id": "156bad1c-0839-4628-bd59-2c66f3b6970b",
"company_type_name": "sample string 32",
"company_type": {
"id": "175aba8a-0cbf-4523-a956-395b363d398c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5a9a11d-0367-4cff-b75a-10b0bdfd1ef4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1a31ab36-b385-4c80-bffb-672bf87baf2c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f0fca3b-f52e-4137-9888-789cf13297ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7b4524f9-882a-4497-afcc-93d976139a33",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "532b126f-3b65-46ca-b2c9-401f9a247a6b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-07T03:20:59.815846+00:00"
},
"company_sector_id": "192c2353-1114-486d-a775-b6fce6e4618a",
"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": "1fae257c-2d40-44e9-9c9e-ee3825534f61",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "541b2a5d-9ab7-4a9d-9e87-32e53c5f6aff",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4291c0fb-3be1-4488-9c65-6a46116ef6f5",
"account_manager_user_code": "sample string 56",
"company_status_id": "56fd5e8e-a84b-4258-ae97-3c2757906e96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-07T03:20:59.815846+00:00",
"id2": 60
},
"db_language_id": "e63e07d3-51e7-49d3-a8a3-11e199344254",
"db_language_code": "sample string 7",
"db_title_id": "afa485b3-4c3f-4f95-b6d2-0f1e7922db06",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-07T03:20:59.815846+00:00",
"create_date": "2026-03-07T03:20:59.815846+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-03-07T03:20:59.815846+00:00"
},
"modified_dateutc": "2026-03-07T03:20:59.815846+00:00",
"id2": 22
}