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": "cd73491c-dab9-42ca-ac18-ea88e8fdd845",
"_parent_id": "39c0896f-e4d3-4170-9f13-14139094e1dc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "35ff2444-007f-4fcc-943c-10643c4ed806",
"company_id": "aa0af168-c446-4f5e-b5d0-78823e187e0a",
"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": "622f0a99-9b75-4aa1-97ff-3b3061dd7163",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f67b7e4a-3d69-4843-ab5b-71226d661ad3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2cf6b1b1-9744-42f0-b2d9-562939eb14aa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5235f634-8575-4b3d-884c-820da42c53bb",
"company_code": "sample string 5",
"company": {
"id": "f4c252ef-0c4f-4111-a2af-c0476f046388",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-29T01:13:50.3143891+00:00",
"sales_territory_id": "8d1c08f3-e27d-4af2-9830-6bfde4c951d6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b48c752a-6ad6-4a09-9f9c-d24516136042",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d68d117-08d2-4f4e-a98c-d82acf6b1b15",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6b93ecb5-01c5-4566-8d5d-e25766593a8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7be455a3-c72a-4cd0-a0f4-b8d00c099580",
"db_currency_id": "a35dbde6-90e7-4ce6-a65c-c80573851c52",
"db_language_id": "ba2b03c3-daaf-4c5d-86e9-b3f879c23ca4",
"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-10-29T01:13:50.3143891+00:00"
},
"modified_dateutc": "2026-10-29T01:13:50.3143891+00:00"
},
"marketing_segment_id": "20fbd661-c323-4faa-9a5c-63a3012a0ec2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2f47566b-7ed6-4775-a143-f56a4d5b6863",
"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": "ac828e98-f79b-48b8-8eaf-fa1eeb1820c2",
"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": "e628a4af-2199-47a6-a2ae-1cf07e08654c",
"db_country_code": "sample string 28",
"feelist_id": "06a9d45e-9d04-46e3-8c14-900d1b78fc1f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b1acfaf9-3865-4065-8249-7ef4f17a679d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d15b7093-3c97-41aa-b02b-137254b19d36",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-29T01:13:50.3143891+00:00",
"db_currency_id": "3de25e6d-20f4-4089-98d4-0abcc06927c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "25f1205d-ee41-4a39-9bc8-b3e50f781249",
"company_type_name": "sample string 32",
"company_type": {
"id": "52ea7989-bc42-4ea5-a845-02a0340b5fd9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7df37fda-7cf5-45d4-940d-bebaa3d4d266",
"sales_organization_code": "sample string 5"
},
"db_language_id": "84becc7f-a772-48b1-a996-63b26a65cfef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fa934081-ac00-4c85-b12b-5bc894547202",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "09c12302-6829-4042-b27a-00e079093ee9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "446d132d-f7fe-4b97-a866-6f41aa1ceefd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-29T01:13:50.3143891+00:00"
},
"company_sector_id": "464b15fd-f22d-499a-aae1-84eda8237895",
"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": "c104dfc6-5d56-437b-9be2-6160afc50d72",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bbe6ca81-4165-4134-a58f-62acd17123b6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c18ae049-48bb-4ce2-afdb-c6d17bbda6a4",
"account_manager_user_code": "sample string 56",
"company_status_id": "7edaf03d-dfcb-49a5-8a58-d1089e0d1380",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-29T01:13:50.3143891+00:00",
"id2": 60
},
"db_language_id": "0399b63d-67d5-4d7f-8ed3-235892afb928",
"db_language_code": "sample string 7",
"db_title_id": "f06e17c6-0ea1-484e-a9ff-68fd6bdcb940",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-29T01:13:50.3143891+00:00",
"create_date": "2026-10-29T01:13:50.3143891+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-10-29T01:13:50.3143891+00:00"
},
"modified_dateutc": "2026-10-29T01:13:50.3143891+00:00",
"id2": 22
}