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": "910f9934-ffaa-43a3-a7cf-8c23d8817c2b",
"_parent_id": "97e6e335-6d48-4aee-b6af-a35f14b943fd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "537c1fac-ffc5-4513-be8f-406a80d071e7",
"company_id": "8e7b07eb-dae7-4983-b1b1-6abaa5b81238",
"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": "af0cfa4a-070d-488f-adcc-1e637b65ab04",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e0f71f0a-bebb-4ef5-bf1b-91fe80db349d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e7a6bb6d-f519-43ed-9a5c-24718f1d13b2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "690aab67-3854-4e4a-875b-18369a23d8ae",
"company_code": "sample string 5",
"company": {
"id": "e2a36bce-8a01-4c39-81a9-1b868aec339b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-10-01T00:21:54.0959125+00:00",
"sales_territory_id": "df5ee120-d061-4e38-a630-5a35734f9ded",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51975f89-df09-4c97-985b-de3e956dfe81",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85b5ba0d-d144-4bb9-a1fd-d592c4a3d7f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ddbb9ba7-9813-4f84-baaf-8666ffeac525",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb21e7e4-fb47-460d-81f9-39e412e7a9f0",
"db_currency_id": "bb1d58bd-4b2e-4247-86ff-089cf6d78563",
"db_language_id": "ad093b2e-d62c-4ffe-b023-99362ab47256",
"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": "2023-10-01T00:21:54.0959125+00:00"
},
"modified_dateutc": "2023-10-01T00:21:54.0959125+00:00"
},
"marketing_segment_id": "3eeb998b-bc7c-4a36-a4bb-7d89ed5aaf43",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "30f1b7e9-68f1-4920-9159-297d81cb3355",
"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": "246c002a-fca6-42f3-8b47-1db4ae61bdff",
"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": "6e6ff08f-7e77-4ba3-9a26-bf52a9747b26",
"db_country_code": "sample string 28",
"feelist_id": "b8d5ed1e-bb24-4668-ab98-c5b831622694",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "101ccfb8-3d23-4c11-ab5e-ae8afe2d8cfc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2bafc23b-0faf-466d-a390-0e5bd74941f2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-10-01T00:21:54.0959125+00:00",
"db_currency_id": "17e1f893-9cd8-4911-af4f-a8699203bd27",
"db_currency_code": "sample string 10"
},
"company_type_id": "e064de97-696f-4d96-be91-7442d418ee5e",
"company_type_name": "sample string 32",
"company_type": {
"id": "8346045d-4098-49a9-b6e4-28407ab41d4b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04e1ed83-3ab0-4ebf-a4ed-b8371ecf69d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0fb8754a-6a75-4022-9820-16c4c16d57a0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d0bee587-45e8-4168-ae53-69dfd1d8a718",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "985674f5-0973-4aab-9647-0a216232f05a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ba5a4a47-b182-4c42-b7ce-93e4a2182c2e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-10-01T00:21:54.0959125+00:00"
},
"company_sector_id": "23988bec-e2a9-4356-accd-efcb6f90a116",
"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": "30aef928-5748-4371-8107-0176bd6c1921",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "84de0134-9cae-4b3b-bfda-b47225486104",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d9aa4794-75bc-4831-8955-efca52d8819c",
"account_manager_user_code": "sample string 56",
"company_status_id": "8dd6cee0-db73-4971-aadf-eccf61591d92",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-10-01T00:21:54.0959125+00:00",
"id2": 60
},
"db_language_id": "f7a3ac9b-e210-4232-ad24-940b7d028f88",
"db_language_code": "sample string 7",
"db_title_id": "683fb71b-a60d-4538-8760-239c9d2fc7d3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-10-01T00:21:54.0959125+00:00",
"create_date": "2023-10-01T00:21:54.0959125+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": "2023-10-01T00:21:54.0959125+00:00"
},
"modified_dateutc": "2023-10-01T00:21:54.0959125+00:00",
"id2": 22
}