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": "1d2290ff-3eaf-4dc2-8b7f-b4621f0e924b",
"_parent_id": "fc84fa29-ce42-41d6-8a30-33fa7a431ec6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b6ed4ac-bcca-4168-bc3a-2eb4e9d68ed3",
"company_id": "f3f43305-dda7-4239-9859-9e81b78b9390",
"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": "44a41fcd-4ff6-4a81-9146-b604a866908d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "16f1b125-3187-4fe8-b060-208f031ab2ce",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0f82d222-31fc-4a33-a2f1-51119d9e4523",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "51ead516-e451-4294-8357-42e3489bb962",
"company_code": "sample string 5",
"company": {
"id": "6bcc35b9-3439-4d9c-8d02-7f1ce53384ab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-12T03:20:00.8916193+00:00",
"sales_territory_id": "9861aaac-2b1a-4ba0-9395-2baeb9acc21f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ee6a180-ff5c-4c48-b627-44a991d34af3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c142aa42-2b5f-46da-bd95-6f03d8143a9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "979fcd37-deb1-47b2-8fff-327a79784af8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eae13823-3bef-40ef-8e61-9a62b412a147",
"db_currency_id": "c08dba03-5d3b-4153-bcd1-b1abad847978",
"db_language_id": "0a2eeb69-d5d8-4fe1-b011-90df1412ccb1",
"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-02-12T03:20:00.8916193+00:00"
},
"modified_dateutc": "2026-02-12T03:20:00.8916193+00:00"
},
"marketing_segment_id": "24db9c33-e0b0-4106-a67f-8b8ba645fe9f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cf7a381d-cf8b-4cd0-aff5-d74957345e8b",
"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": "1dec5234-13bb-403f-b979-e56e895bd331",
"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": "d7d045a5-23b5-4fd4-9fcc-21787f1bd63b",
"db_country_code": "sample string 28",
"feelist_id": "102971e3-f23f-474f-9d7a-9884b6261a2e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5eeda1a-602f-4e44-b5cb-fc75f6292775",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64737f1d-5c40-430d-9538-09baad35f053",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-12T03:20:00.9072466+00:00",
"db_currency_id": "3f6e4861-b6ee-4325-9829-8d2f9b85ff4e",
"db_currency_code": "sample string 10"
},
"company_type_id": "ce069354-b057-4406-8d1e-1b0908530eeb",
"company_type_name": "sample string 32",
"company_type": {
"id": "091ebf88-2619-42c1-9955-3fafc0842c20",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66815e04-b7a8-4fa8-b26e-e14b2270cbf6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a98a63ce-cb83-4eb2-8b1b-03d53a5b0a95",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "678b2d8b-c4f8-4901-a395-681fdef20835",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c250c2ca-c818-43ed-ae25-320055a424e5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a73331b4-809d-4b6d-a18f-dc3647a9be8a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-12T03:20:00.9072466+00:00"
},
"company_sector_id": "68826ac7-6931-4f8d-b827-4c5c2f5d9f60",
"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": "5a8430f1-d972-480a-a656-760cdc679068",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "045d6ba6-52a4-4222-8980-0c5eeb968f86",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1661da88-06c2-492f-b2d0-d0822ab0b5ce",
"account_manager_user_code": "sample string 56",
"company_status_id": "a5e2c774-0829-4fb5-a8e5-c3aeef19fdcc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-12T03:20:00.9072466+00:00",
"id2": 60
},
"db_language_id": "772da15e-bb14-4c79-a4ac-4a685372a92c",
"db_language_code": "sample string 7",
"db_title_id": "2f6e9b0b-7aa4-43fc-b33c-56340d355b5c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-12T03:20:00.9072466+00:00",
"create_date": "2026-02-12T03:20:00.9072466+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-02-12T03:20:00.9072466+00:00"
},
"modified_dateutc": "2026-02-12T03:20:00.9072466+00:00",
"id2": 22
}