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": "9d176043-f845-4849-a306-15cb5d11e942",
"_parent_id": "ad48b761-e96f-4f4a-8828-8c151b1c84dd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fbafc0f0-f8fc-4d24-881d-ff81341fe229",
"company_id": "4d392e8b-b192-43d8-a2a3-e444b52d2051",
"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": "fd4c284c-88bb-4478-80fb-15f23aa3ec58",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "08895ca5-a70c-4450-a7d6-21dd11ed3c25",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "01fec3da-0131-447b-8fa8-19fae2ee7342",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc604496-4ad5-4176-8a4f-c0cc1c5bba23",
"company_code": "sample string 5",
"company": {
"id": "84937e84-c554-4299-b48b-601228be44ca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T23:43:12.0794306+00:00",
"sales_territory_id": "501aa886-1e9d-4a98-a7be-90f792c8a49c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8cae437b-6e54-44ac-93ac-6235336a2a57",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87a7dfde-d8b7-45d2-9466-5651a6008277",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a1fa583-ad3b-468d-824d-0ae2b271ebc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9ed87b5-7f5c-41b7-bd4f-24c9b7ec05fe",
"db_currency_id": "8fad7b0d-5ce7-4882-b8fc-b146a8f7a679",
"db_language_id": "de498516-03cb-43c1-80fb-6178375e4da7",
"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-12T23:43:12.0794306+00:00"
},
"modified_dateutc": "2026-03-12T23:43:12.0794306+00:00"
},
"marketing_segment_id": "ce7891cf-99f6-4451-9ebd-2d8ca058f2b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5258e725-2a12-416a-ae93-1cf58b8d6be2",
"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": "fe8ae9de-db82-4c2b-8cb7-dd564865097d",
"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": "dbc19cf3-4235-4988-b0b4-91ec6d80c288",
"db_country_code": "sample string 28",
"feelist_id": "855a91c0-c405-4309-a3d0-20518cc5c66c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0dcf0396-6b6d-4525-868e-2ce826569165",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "385e3212-c3cf-49fe-90b0-2a1b4914896a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T23:43:12.0794306+00:00",
"db_currency_id": "3f954027-6c4f-419d-900f-8d617d671b4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "91c3287c-f2b5-4c13-a13b-2fb68c04c83b",
"company_type_name": "sample string 32",
"company_type": {
"id": "5f02f808-f04a-4456-bc13-fb4f6d404f42",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ac17e4a-c50b-49eb-a931-23b03c3d5381",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3193fcc3-cc58-4671-b74d-642222b1777a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "08058bd4-6f01-4466-a9b2-f3e5a5152343",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "60600cb0-d33a-4ec7-8cab-93d4d78bde17",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0a893790-1f3a-413a-9676-91613383ae35",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T23:43:12.0794306+00:00"
},
"company_sector_id": "13c280fe-34de-4170-b922-28ce9e814d8b",
"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": "82ef4206-4e7d-4292-9dcb-7192217fa518",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "466f9388-109c-4f5b-a6c5-b443dd067441",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b4090143-54e8-4eb2-a0a1-bb1368276105",
"account_manager_user_code": "sample string 56",
"company_status_id": "e9b3449e-8e58-4fd2-8593-de7c213d896a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T23:43:12.0794306+00:00",
"id2": 60
},
"db_language_id": "dda0b585-e140-4f4c-ba18-12c1a111e8f8",
"db_language_code": "sample string 7",
"db_title_id": "9f8ceb27-b27d-47d4-b722-62ab425bf78c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T23:43:12.0794306+00:00",
"create_date": "2026-03-12T23:43:12.0794306+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-12T23:43:12.0794306+00:00"
},
"modified_dateutc": "2026-03-12T23:43:12.0794306+00:00",
"id2": 22
}