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": "12cc02a9-e04d-4753-baf7-72ae9ef546b1",
"_parent_id": "b913eb65-4ec1-417c-9abf-5c270003b644",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "084c1584-b5ed-47bc-8960-f4c6af3cc78e",
"company_id": "58193669-c695-48ee-8448-489f644fbfb8",
"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": "a03a3d11-bfbd-4175-8e7a-c21cf5df21f3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d2ed29e0-9a9d-4700-95fe-fac5d6876efb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f4b47814-842e-4d5a-bacc-24efa475bf89",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5a67a311-5e0e-418c-a9d5-aa8bd061c6c8",
"company_code": "sample string 5",
"company": {
"id": "cf9ebfdb-dad5-4724-9eaa-68b602546db3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-15T16:24:32.558274+00:00",
"sales_territory_id": "b748a605-209b-4850-bab4-d831d65109ad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e65c3235-470d-4b4f-bcb4-83966bf16678",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "841a59a3-52b7-4b39-a356-2684528f03d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a404b51-cc89-458d-ab14-765a19ac2d73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cb49f-4162-4f45-8c70-34a2dd4fd119",
"db_currency_id": "50658870-5613-476e-a394-2d5b0bda0364",
"db_language_id": "12976ec9-41ad-4de9-a234-e0ef9dafdb5b",
"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-09-15T16:24:32.558274+00:00"
},
"modified_dateutc": "2025-09-15T16:24:32.558274+00:00"
},
"marketing_segment_id": "5bbdb854-db61-4317-90e8-0a41a93a13c1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "be76f407-6484-47a7-9bca-9c2e31fd4404",
"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": "5f1037dc-9715-4890-ad4c-9cada592d0bc",
"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": "8d4a54f4-4949-4229-a305-da79a08d7aab",
"db_country_code": "sample string 28",
"feelist_id": "097ce3a7-af22-4921-a535-05e6b979e000",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "05989fa2-704b-4e1f-abc2-2e8fbfa27ffc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6ad1cf4-f4e0-41f6-8259-fe5c28bc52dc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-15T16:24:32.558274+00:00",
"db_currency_id": "ff01a201-c6ed-4532-b3eb-f817d6aa41fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "d468c1c8-777d-425f-b5a4-f02ca14fab45",
"company_type_name": "sample string 32",
"company_type": {
"id": "97898476-342e-4580-b706-73e6bdb131c6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4136693a-02b3-48b8-82d3-b43c0d13c5ce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a520b1e1-5848-47eb-996e-0fa2e608b08f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4af42bff-2ffd-4735-aed1-8a4dbf79f8f8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "63512c5e-579d-4fcb-8c7a-8f4325316176",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "41ef8ace-336b-4ac3-955f-0cbeeb31b224",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-15T16:24:32.558274+00:00"
},
"company_sector_id": "78dc93e5-838e-408f-a1c1-126d74f2508d",
"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": "2f4933da-456c-4858-aa68-c5aa3ed4bc4e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e376d955-ab69-4b20-9804-5a478ff4a02f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "66ec96f5-e6d6-4b17-bfd1-509212ea1ae8",
"account_manager_user_code": "sample string 56",
"company_status_id": "65668ad4-19e7-4792-8131-6b68e55cf064",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-15T16:24:32.558274+00:00",
"id2": 60
},
"db_language_id": "5cab7c3a-f842-47f1-b6ec-d2bb2bddc718",
"db_language_code": "sample string 7",
"db_title_id": "57e0eee5-8b85-4a8a-9a2e-2c4024bd177e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-15T16:24:32.558274+00:00",
"create_date": "2025-09-15T16:24:32.558274+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-09-15T16:24:32.558274+00:00"
},
"modified_dateutc": "2025-09-15T16:24:32.558274+00:00",
"id2": 22
}