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": "292b13a6-aaac-4798-82fb-a403deaad767",
"_parent_id": "fc64dd95-25ba-4281-b442-6882d9c3a58e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d6b474b7-8ca3-4338-83e8-ccb779e0f60d",
"company_id": "93db095e-3155-4e1f-b37a-0bb6ca08d89a",
"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": "5d37d383-85a1-4a8a-beb9-9abc58465ed3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "90b343ba-6b5a-4439-9531-a7a9a8eaf979",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c9a0cb1d-4989-4e67-96fd-55dd37678ff0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0333ae1f-42f4-43b6-9f8c-9eed9536070d",
"company_code": "sample string 5",
"company": {
"id": "994c2779-0fa8-4d4b-b0c5-a018c4cf28e1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T04:13:08.6454659+00:00",
"sales_territory_id": "4565d028-5894-4e47-8169-a7fb9a59bfd5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b1609749-2f69-4ef7-a25d-6e0b47da3d87",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3723d8fc-4cf1-4fed-b423-c080de2f235a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1a71b92-0a8d-4c68-97c3-2d7dca2ef36e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50bbb184-ed75-43fe-b5c7-108bb2ac2fe1",
"db_currency_id": "3f0f3d37-c4f2-4327-a782-d63f316d56cc",
"db_language_id": "a605730b-e5d6-4ee5-a10f-26a2b387fb0f",
"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-09-04T04:13:08.6454659+00:00"
},
"modified_dateutc": "2026-09-04T04:13:08.6454659+00:00"
},
"marketing_segment_id": "e5126836-6d53-410d-b515-6cdb3d54d0e9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0fd09f6f-a13a-45cd-85d8-78fdd27ad691",
"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": "140f7994-a6c0-46e4-85a9-ea06ddbb02f1",
"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": "852eab74-bb96-4437-91db-6459b0cd84e8",
"db_country_code": "sample string 28",
"feelist_id": "33cc63da-048b-497e-a565-27660d3dea23",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fc2a855b-24f8-4efa-b7bb-24205295c69e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "428157b8-a806-4893-89cf-52cf90d6fe36",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T04:13:08.6454659+00:00",
"db_currency_id": "586047fb-a0cc-4806-b861-8fc3ab9f99f3",
"db_currency_code": "sample string 10"
},
"company_type_id": "2f147cdc-7dc6-4c4b-b5a9-e332503260e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "8135fae8-5a41-4cb9-81a7-4315a7947d65",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae3bcc4c-f744-4d16-82a7-36bfb464cb1e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "11cc90fd-a7c7-4847-b544-fc369648b715",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf5bca41-5ab2-48fd-b616-50468beaac97",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9bb2ad01-a873-47c0-ba34-237ee628e3b5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ceeb86f5-e37d-4392-8ca9-460983fe9ee8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T04:13:08.6454659+00:00"
},
"company_sector_id": "ad1edf10-9ea0-4bc1-a73c-b96d87e1c644",
"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": "642afd7a-76d9-419d-99df-f26c82db7e13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "667beff2-aef2-4df7-8083-9cc98e294cb3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb4a7d14-c3a2-476a-ae2e-bcf4995b7807",
"account_manager_user_code": "sample string 56",
"company_status_id": "a19e9370-b412-4489-a2ef-67adc121dbbd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T04:13:08.6454659+00:00",
"id2": 60
},
"db_language_id": "2dbcba7c-2dae-47c0-9139-704db7f12c47",
"db_language_code": "sample string 7",
"db_title_id": "fd6e3ba5-2f19-4256-8f98-53cb85a4b1bf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T04:13:08.6454659+00:00",
"create_date": "2026-09-04T04:13:08.6454659+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-09-04T04:13:08.6454659+00:00"
},
"modified_dateutc": "2026-09-04T04:13:08.6454659+00:00",
"id2": 22
}