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": "60f36beb-0c22-41a0-91ce-eecc5fb78167",
"_parent_id": "9815984c-a3ed-49d9-b0bb-c3519c54ca07",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1098c8a0-94fb-4071-b1cf-84fb24168266",
"company_id": "ff01603a-83c7-4023-bee8-b863e3c8f082",
"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": "b0556bad-7ff6-4194-941f-aa684644ad3b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "85d175e5-519c-4053-af2d-68fdfcd55b1e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f621c13e-5674-4cca-a015-9e43e1f6fbf1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fa17ee53-b480-412d-a613-569e2ae6a20a",
"company_code": "sample string 5",
"company": {
"id": "b4941cb9-85aa-416d-a067-71e67339b3bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-15T02:05:27.138758+00:00",
"sales_territory_id": "02843dc5-c29d-450a-b4c7-0143d4fd0580",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "edda58cf-2faa-4398-95ef-8d93227a74e7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d44f4873-9161-48e8-9dbf-ce1f3e1373cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08017711-755a-49b9-83b4-0d7c78b6f5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f98e9a17-44fb-4b9e-9948-f6dd0bf4a53e",
"db_currency_id": "6e6579ca-b25f-472f-83af-fd0e77f6b546",
"db_language_id": "84d7a6bc-07b6-4c72-afe3-f9e08e09a8ef",
"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-15T02:05:27.138758+00:00"
},
"modified_dateutc": "2025-09-15T02:05:27.138758+00:00"
},
"marketing_segment_id": "388c73fc-4702-406b-8f31-c42301f63b60",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3803e7ea-ae40-49ce-a546-b0611bb5114c",
"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": "2cdb0127-b3f1-408b-ba51-2b3e82e4d9bb",
"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": "82d1108f-4b5f-4e01-b996-899d11f7eeb5",
"db_country_code": "sample string 28",
"feelist_id": "349a16a7-6315-4f1e-a054-c447acd448fc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "662a888b-d94a-46f8-a005-230e8475147e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c2ea426a-acca-4fe7-be2d-6400fc4e87a2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-15T02:05:27.138758+00:00",
"db_currency_id": "f0234984-f11d-408e-b71c-a0085f413e99",
"db_currency_code": "sample string 10"
},
"company_type_id": "991fce30-3160-4b26-84d2-def890f8665b",
"company_type_name": "sample string 32",
"company_type": {
"id": "e007fbde-7c83-41d0-885e-4390b78415fd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df0aa179-2690-4ef9-bb66-384e7c2ed528",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5978b31e-1306-4491-8dd1-4011191bcbff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "65390dab-a5bb-4bcb-935b-81b4a90e9400",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "474fb7e0-a60e-46ae-9626-dc10a2b6993d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3806f5b7-8ac0-4515-9729-f0566d55c4d1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-15T02:05:27.138758+00:00"
},
"company_sector_id": "05c25976-fb03-4d0b-b6ed-fd97ef943ad1",
"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": "f76ce847-b99f-433b-b401-a1cc883a7e9d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1f1a705d-c11c-467e-b3ed-919fc45be46a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "af74f554-1055-4a85-be2c-9ce5e0ad54ee",
"account_manager_user_code": "sample string 56",
"company_status_id": "c69f7e4f-3340-45e3-9256-bf7cfde68aa3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-15T02:05:27.138758+00:00",
"id2": 60
},
"db_language_id": "dd01e9d9-738b-405a-85d0-09e86f8891df",
"db_language_code": "sample string 7",
"db_title_id": "d89e97b8-ef45-4faa-9131-d0a91d10fc8d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-15T02:05:27.138758+00:00",
"create_date": "2025-09-15T02:05:27.138758+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-15T02:05:27.138758+00:00"
},
"modified_dateutc": "2025-09-15T02:05:27.138758+00:00",
"id2": 22
}