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": "381bfb7d-73d5-47ee-a287-d0663693a162",
"_parent_id": "e14ad9a0-eb0e-48bb-bdcb-6d8d48835dc6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5cadacda-018a-4b68-8ff8-a2dda6d84456",
"company_id": "50d6bf59-fec0-473c-8a36-4efdef4620fd",
"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": "53688d7c-0d11-4a0b-ab10-d5f20e684639",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "403b797d-4e76-4817-83be-d08d23693567",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "48ce2b8a-7f7f-4cc4-abbe-e2dd518028ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9d8dbe1d-b9ac-4497-97ea-f6803dcca159",
"company_code": "sample string 5",
"company": {
"id": "d9d89136-c7f0-49bb-901c-1140c86921fc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-02T12:34:54.8198963+00:00",
"sales_territory_id": "d88bb50c-018d-49b6-96ff-5948cc2b0c93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6c43846-9780-4fa6-a383-44732908cd37",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc352228-738d-4450-91e6-5fed50733ed5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "28f912e3-98b7-45c5-a1ad-6afc22eeb039",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d46f1a18-8c41-459b-be7b-cca6dd13293f",
"db_currency_id": "b44abf25-29d3-4936-be97-cf4c56501f42",
"db_language_id": "8f2eda65-c7df-4821-b18d-bd6f7f3703ec",
"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-12-02T12:34:54.8198963+00:00"
},
"modified_dateutc": "2025-12-02T12:34:54.8198963+00:00"
},
"marketing_segment_id": "36c5aed8-b444-4f4e-8680-3a2eef842fb6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d31363ce-41b0-4c62-befd-aaabd56d938d",
"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": "7c320b7b-4b32-471a-b108-1daaba8eae8d",
"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": "2bb91960-794a-4808-ac78-e4528d1cf606",
"db_country_code": "sample string 28",
"feelist_id": "adc5e4d3-d3e1-4f6b-8adf-851beefe2653",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f02907d7-70cc-45bb-8f21-d2dbd6de2d3a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09e1cc61-de69-473a-9f95-7f9eb7af3092",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-02T12:34:54.8198963+00:00",
"db_currency_id": "e9e01308-09cf-4600-a793-67410668b884",
"db_currency_code": "sample string 10"
},
"company_type_id": "de366db5-2dba-4c2b-b059-76d7d6fdcdcb",
"company_type_name": "sample string 32",
"company_type": {
"id": "748776d5-140f-4cf6-8aeb-efd198efaf1d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2bca3159-3629-40f4-b82c-d296d052dda9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9c2a80b8-8473-42da-9a84-293612f465c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e35f04ff-e23c-46ed-883d-511c20783ffc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aac0befe-e2c8-46e6-b132-2658e452636a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f9abf1c-760f-4afc-96b0-63c7ca7b0eeb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-02T12:34:54.8198963+00:00"
},
"company_sector_id": "ad5f951e-23f2-41fd-a9ef-02cfd9d7ea6f",
"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": "534b9784-281e-40da-b5c8-e14c425d2d70",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b2c59699-6a05-4011-bb59-a3a8c5cb0268",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bba0fb0d-67f7-49aa-ad3b-896d69b648df",
"account_manager_user_code": "sample string 56",
"company_status_id": "2e70d179-9d6f-4983-bc40-fca4cffe5f6c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-02T12:34:54.8198963+00:00",
"id2": 60
},
"db_language_id": "8731d5f5-5f97-4434-aa20-0dd7a29b59a8",
"db_language_code": "sample string 7",
"db_title_id": "81da8cb4-2a4d-43ba-8869-409fce4a6d52",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-02T12:34:54.8198963+00:00",
"create_date": "2025-12-02T12:34:54.8198963+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-12-02T12:34:54.8198963+00:00"
},
"modified_dateutc": "2025-12-02T12:34:54.8198963+00:00",
"id2": 22
}