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": "60df008b-7e0c-43ae-a3b8-0896a541e359",
"_parent_id": "8395853f-e608-4c3b-866a-136310d98c2f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fc94d560-00dc-4dee-ada3-f569ac3be6dc",
"company_id": "b6cd1f59-1bd9-41a8-b41f-d71ebb067086",
"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": "b2a6a8ec-784d-4250-9a61-e87a87b63f56",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1b4d1b8d-d88e-42bd-a2e3-4d53e07639d4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2a6d0abb-dded-46e6-b4bc-4b9d606b4c3d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "702622ce-d970-467d-850c-6dc285516590",
"company_code": "sample string 5",
"company": {
"id": "3cc0290d-e601-4f43-9975-0fa8155b5a2e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-01T14:55:40.0030184+00:00",
"sales_territory_id": "2b51e70d-d410-450f-b3eb-d74a70870d99",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fbbad766-851c-4a19-88e5-d3a8119103a4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "829ed756-f6da-4251-9388-dfab503af08a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9998a16a-4201-4356-85eb-2443b0f4ef49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2ee3926-ca98-4f82-b3fb-44899d6f4a39",
"db_currency_id": "c33b4d79-4108-43e2-a9fb-d8896af7b584",
"db_language_id": "99b563b5-0cc0-4ca0-8a06-eae67dbdf1e6",
"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-01T14:55:40.0030184+00:00"
},
"modified_dateutc": "2026-09-01T14:55:40.0030184+00:00"
},
"marketing_segment_id": "960173eb-66fa-4b1e-8df0-393e99ccf575",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a9077a8e-081a-44f0-8794-fe277e30163f",
"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": "ac3db60f-0b6f-42d8-95d1-9fe8deb14fdc",
"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": "d3b8e09d-a421-4e5c-b01d-d16841760717",
"db_country_code": "sample string 28",
"feelist_id": "7f05e7b3-2d83-428d-99f7-d9287102c8c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5e78c5e-784f-4d12-8bcb-eacf182b7e70",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "16c2d3d5-5ef1-400b-bf4a-47428d1af14b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-01T14:55:40.0030184+00:00",
"db_currency_id": "1ea57f4a-c86f-4dd9-8521-7365768620bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "9fa2e8a0-cafb-4420-988c-cca28843a12d",
"company_type_name": "sample string 32",
"company_type": {
"id": "748ba1fd-c0f1-4d59-8d47-79b3356a5d59",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "900eb586-6b9e-453e-8e1c-e1f67ff213e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c67b2622-45a2-4089-b570-ad8e0469f541",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95e5743e-299d-4ca5-88ca-b81f4fec0f1f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "40c96dcb-f205-420b-bd84-0ae9f4242d7c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "881c63db-cf6a-493d-8427-82be29ecc377",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-01T14:55:40.0030184+00:00"
},
"company_sector_id": "4901d4b8-ec3a-49af-99cc-dd1b4b042e2e",
"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": "7d9039c2-193b-4ba9-97e7-e37c040d56bf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d8d0825d-11d2-4bf3-8eb6-14c2729e5ad4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "60c5844c-521a-4916-94a0-2542a8155ac2",
"account_manager_user_code": "sample string 56",
"company_status_id": "2799c922-7ffe-4cb6-b149-3ea3c80e5b2f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-01T14:55:40.0030184+00:00",
"id2": 60
},
"db_language_id": "b4125317-e652-479d-8c00-7c08347fcdcd",
"db_language_code": "sample string 7",
"db_title_id": "9e1ccc4b-46f4-4b28-bae1-294b1eb0397f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-01T14:55:40.0030184+00:00",
"create_date": "2026-09-01T14:55:40.0030184+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-01T14:55:40.0030184+00:00"
},
"modified_dateutc": "2026-09-01T14:55:40.0030184+00:00",
"id2": 22
}