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": "ae970b75-dd1c-4e0b-976f-ae71357c9f4f",
"_parent_id": "b48b063a-3899-4ce7-b389-5cf3f195fac3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0c393a67-6572-440b-b729-8611e469d31c",
"company_id": "0085cd7f-9d9c-4898-9451-fc805e9ea09a",
"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": "b11cf409-0f2a-4efa-9a7f-65be86684620",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "034608c8-31bb-4bb9-be5b-285e6f271c3d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9fde10d3-b60d-4e18-8755-547466b3ecc1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "53949f08-922c-48e3-bfac-26cfc893cd4f",
"company_code": "sample string 5",
"company": {
"id": "2ae7beb5-1d45-432f-b218-b2b0bff733e2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-23T02:03:31.158086+00:00",
"sales_territory_id": "a0f325fa-5410-4147-af6c-1f50b8d541e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6625e33-e2a3-4508-aa27-dbe8401f39f6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41649e0b-b199-4323-bab5-9d88f19cc3ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d27b8f1-2ef5-4eda-bc8f-13f1fd197a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ccb6c01-83c2-4985-9d0d-c32c8d74327c",
"db_currency_id": "4d86fce6-e3d1-49c1-b1f0-b2b41ad9c698",
"db_language_id": "ec582e93-09bc-44f6-b823-be2fb32f1a51",
"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-06-23T02:03:31.158086+00:00"
},
"modified_dateutc": "2026-06-23T02:03:31.158086+00:00"
},
"marketing_segment_id": "0539f403-25da-44b8-9649-c50b098f62a8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "131354e8-3f4d-4331-8c57-7f03b6a4f2e6",
"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": "6301ce35-cf21-40c3-9727-4ec13cb9ddaa",
"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": "dff026d4-bf9c-48de-98c5-d8ad4c3f29b1",
"db_country_code": "sample string 28",
"feelist_id": "7d4d835c-3567-4268-9e43-5bc4e60c945e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75bdac08-62ba-4137-ac3f-e91ae65730cb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "008d532e-5208-4223-9f35-b161170eda53",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-23T02:03:31.158086+00:00",
"db_currency_id": "b049583b-7556-42cd-99d3-3845a6e6ff77",
"db_currency_code": "sample string 10"
},
"company_type_id": "56c0165a-1264-4932-b832-a714ec100021",
"company_type_name": "sample string 32",
"company_type": {
"id": "a15b5e2b-3dce-4936-87f8-f6a2f8a58e97",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1efae8f9-9f3f-4c8d-80f3-658f9d841e6e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7db684a1-ba53-48b6-bb83-bc7f7f6e190c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3688c0e1-7308-4041-9762-cc157092b89f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "08eb19e2-5932-4b0f-a354-df6b97c2c01b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ec034e6-3363-4c67-b3fa-ff80447a25ad",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-23T02:03:31.158086+00:00"
},
"company_sector_id": "088e3823-ad5c-4b30-b122-08107876d0d5",
"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": "bff262fe-f416-45e0-adf0-7b3cb5eb69ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "083baf2c-d1bd-4f1c-9b33-0a34590d25c8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9653bf36-3fb2-4f17-b686-da5b45a65774",
"account_manager_user_code": "sample string 56",
"company_status_id": "5febae5f-2de8-41b1-885c-6745835dc58e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-23T02:03:31.158086+00:00",
"id2": 60
},
"db_language_id": "5960d0b3-d198-47aa-bcb0-8cb5676c83d4",
"db_language_code": "sample string 7",
"db_title_id": "954dd2ce-974d-4cb9-a767-530076d0562d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-23T02:03:31.158086+00:00",
"create_date": "2026-06-23T02:03:31.158086+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-06-23T02:03:31.158086+00:00"
},
"modified_dateutc": "2026-06-23T02:03:31.158086+00:00",
"id2": 22
}