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": "04cbbccf-7fc6-45fd-80fc-426eeec54e2b",
"_parent_id": "589fbce3-4345-4b81-b899-6a316ba4a330",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "07706c58-c613-4556-a5f4-cd0e02ec2b18",
"company_id": "a0811c66-4390-41b9-9aa2-5b6906e3d4de",
"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": "ef7ea141-ca84-4243-88c7-3cd91f655154",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "778a946c-58cd-4673-bff4-4a709715ad60",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c8c17232-2c28-4941-8990-8172ebe3353d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d910b65-c9b3-4053-930e-33ad556b9b18",
"company_code": "sample string 5",
"company": {
"id": "182f167c-f9dc-4c91-9966-1f62d4d2e0bf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T14:44:50.9550872+00:00",
"sales_territory_id": "429a3fa9-c1bd-481b-adef-6f7100676f69",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1f8b6dca-424c-45a2-b76b-53b84314eeb4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "201f53af-4e72-42a9-bab2-2c8b93f8a148",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d183081-d4bc-495d-9fac-7daa7f55cf71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa962fce-4f20-43f2-b9a2-958aeb8f390b",
"db_currency_id": "95e0c138-8e2b-46e3-9435-2def603dc6c3",
"db_language_id": "4c6552b4-e0c3-4ab9-8f73-3e33df692f08",
"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-09-30T14:44:50.9550872+00:00"
},
"modified_dateutc": "2026-09-30T14:44:50.9550872+00:00"
},
"marketing_segment_id": "cb054ebb-93bc-426a-b316-c13c8946f216",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf29566e-b6d4-466c-a020-cd3a97ad4ea8",
"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": "2af5ef2d-aa4f-4625-a463-46061ed06af5",
"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": "c518bbe6-b277-4d4c-82be-b07195201d48",
"db_country_code": "sample string 28",
"feelist_id": "6c4629f7-9921-4c77-a91a-f9c55041603e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e15b352c-1591-4cd4-b5e4-4c1f1699b3a6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5a03c34e-0da1-44fe-a95e-3fdbf6567604",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T14:44:50.9550872+00:00",
"db_currency_id": "beea5302-b367-458f-a02b-741f9030d440",
"db_currency_code": "sample string 10"
},
"company_type_id": "44c57c78-88d5-4567-8e5a-820de737a0c7",
"company_type_name": "sample string 32",
"company_type": {
"id": "125f1cfc-9daf-4228-a157-53491a40d4a6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0012c70d-7d20-4bd4-bb2f-dc33e466b7d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8774970c-68a4-4cf3-ae18-369d0a585853",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f0f2321c-0594-416b-8e24-d34756924765",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4029f83c-3787-4d3f-b7b8-5999bb0e5808",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1ed8d269-fd7a-40db-bfab-cf7cc770a33c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T14:44:50.9550872+00:00"
},
"company_sector_id": "1b5e2925-4b11-4e63-8359-208f4e3598be",
"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": "e99a62ae-181e-45cd-8660-f9ba8dd7f6b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ae739316-f462-4b96-8b93-4c1698e22377",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e1cee04-3256-44e8-98e9-2c9cb3fc63c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "a233d856-daba-4cca-bc2d-dfc97de89aa2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T14:44:50.9550872+00:00",
"id2": 60
},
"db_language_id": "aa95e3c9-1ba0-47fe-a97e-5d0ef67c9169",
"db_language_code": "sample string 7",
"db_title_id": "57fe39e0-486e-4cb8-8798-2e316e332330",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T14:44:50.9710227+00:00",
"create_date": "2026-09-30T14:44:50.9710227+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-09-30T14:44:50.9710227+00:00"
},
"modified_dateutc": "2026-09-30T14:44:50.9710227+00:00",
"id2": 22
}