Creates a new location object
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
Sample:
{
"id": "8eff8a19-8de4-48e7-9a8c-e14c9a8434a5",
"_parent_id": "e33972d6-ede6-441e-9fcc-8ec72c41a319",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e4b0eb45-7e14-43a0-93f2-062fb5c7d703",
"company_id": "434c8555-fcd2-482e-9f04-d3282f743194",
"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": "ce6930d0-c4b5-4de4-8ccc-3b37bc5d6df5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "69d5523d-1ed2-4649-80ea-a07a891b3978",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1610e332-1601-4e8d-af1a-b6a752c3b171",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1bb64935-c2ba-454c-a542-f47b53529ab4",
"company_code": "sample string 5",
"company": {
"id": "38c06076-3baa-44b8-bf1d-91d9cba05ba2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-09-16T08:21:46.0733086+00:00",
"sales_territory_id": "5e562235-74a2-48c4-a796-ce3a3062e94f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "150c71c9-5e30-42fc-bf8e-63c6b9f42fea",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffca058b-b5ed-4320-b8e6-3907d22c163b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "234d4096-955f-4be6-91e0-639bd2c6ed9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93298465-a0f2-4a09-8ad9-6d83db3ab279",
"db_currency_id": "02e1b64d-881b-4b9a-94ca-93eb85c74827",
"db_language_id": "2e3f515d-4dfc-4c8f-b572-fd4fec2e7e65",
"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-09-16T08:21:46.0733086+00:00"
},
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00"
},
"marketing_segment_id": "3d365629-eba7-4ffd-ab11-78bece26da34",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ed0c8421-6da7-4102-a128-8b3a678a3b03",
"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": "5420737c-db44-4dfa-b5e7-caaa1abdc41b",
"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": "6003ff55-bfe4-428b-9e11-9f2a55b5e517",
"db_country_code": "sample string 28",
"feelist_id": "7830af6c-d11c-40f1-913e-f47b46cf79bb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ed147b10-972f-40bb-949f-3e52d4207e17",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9ccbfc6c-2ef9-409c-a1a2-5cc3e44fdce2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"db_currency_id": "ed715d5f-2557-400d-b85a-01ebdd667719",
"db_currency_code": "sample string 10"
},
"company_type_id": "0fdef1d1-4358-42a6-be3e-b30963713150",
"company_type_name": "sample string 32",
"company_type": {
"id": "ea55a9a6-ec6d-4ac3-833c-a5c6a7e14322",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c066cbff-1ff0-4dac-a97a-78fee958ab43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "abbd0226-ff9a-4e0f-89ac-2b476c7e2c0b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0e496617-a856-4aa0-a909-0b75c656f067",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "57df0640-492c-49cd-8ed2-3bc6a9961ace",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ffec1fe-e846-43c2-9ee0-3fa8c6b98cdb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00"
},
"company_sector_id": "8797fc64-702a-4c59-a5a4-d735fb9e4a5c",
"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": "711d4cf3-17b8-40a4-b604-5d80ed16ed0d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb2b5c1c-4388-4ee3-b2dd-bc4b426a2552",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "946ed004-de5a-4a6e-9dce-415086f3280d",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ea882d9-35c3-4759-9e9c-fed56fbddd15",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"id2": 60
},
"db_language_id": "c8889f62-390c-4cf5-aee9-33d1f7595b07",
"db_language_code": "sample string 7",
"db_title_id": "79ea4359-9a65-48c8-8527-21f1249270e4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-09-16T08:21:46.0733086+00:00",
"create_date": "2023-09-16T08:21:46.0733086+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-09-16T08:21:46.0733086+00:00"
},
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"id2": 22
}
Response Information
Resource Description :
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": "0dbf99ef-d3a1-4773-8d2a-0d85e18e04a2",
"_parent_id": "d8a7378f-2f73-4cb7-89f6-887f7b66ca41",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "210a7269-c85c-4449-9759-fedca9932774",
"company_id": "484f4121-048b-4f2d-866e-8b635f6fdd20",
"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": "bcaf3558-05b5-4f73-9c52-748a449699ee",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8257b078-f7a3-47ce-b428-b2fbba050f49",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "597f9f51-ed11-4854-b87b-076490f7ba98",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b3afda72-b1b8-416d-975d-9740c3926f2b",
"company_code": "sample string 5",
"company": {
"id": "f50be312-1952-47e5-a08f-1d69d1f72a72",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-09-16T08:21:46.0733086+00:00",
"sales_territory_id": "bad2bf45-5191-4cb6-aa52-824687bb0a1f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "78b4404d-5a3f-4e1b-8de9-7d52cf2ec0e3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afad5e55-5c88-4d2f-b63e-a327a8e5ceda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7dd3d63c-1e6c-4162-8586-41d27ea03bcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5413a461-8fea-4022-8356-30ee4da4c6d8",
"db_currency_id": "7f9760ac-0e96-49be-ba7d-eca0c001b523",
"db_language_id": "0304217a-5d31-4dea-9595-2fa96d3c97c7",
"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-09-16T08:21:46.0733086+00:00"
},
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00"
},
"marketing_segment_id": "489fc9af-1d86-45ff-a933-9123cd297b7e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d37bda7a-3d84-4c09-849d-6d0e7b3dc510",
"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": "63ce9bb3-2488-44e1-b3f0-1863213f031d",
"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": "a8ea1f11-4025-4e44-95fe-4a3af2e0ce62",
"db_country_code": "sample string 28",
"feelist_id": "e004ef83-d9c4-4d89-b136-d74203d43a6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bb559cac-e142-4589-91ae-7ef7cba264eb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ce8fcf6-a5b5-4139-9233-277e1fae9849",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"db_currency_id": "08dcb36b-11f1-4687-bf0c-4535b0265fc2",
"db_currency_code": "sample string 10"
},
"company_type_id": "d258db8a-360e-427b-af70-710e0fb8f31c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ea014d25-fc46-466e-aee7-b4f2d5efd926",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e43d5723-28c4-4fe4-8e8d-1dc390b89929",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7e0796b-6b03-4508-8b5f-18863db978af",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f04d538-32ee-49c2-b818-3f25a7938d52",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0bf79d1c-86c3-4908-8a0c-512908047f56",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "21f3c21b-3700-40d9-9eef-758eb6b2330a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00"
},
"company_sector_id": "6b0bce0d-a673-441c-ad4a-09b1ae672d96",
"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": "7c836344-f0fd-4c60-bf67-dfc5cfffdb85",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89f17076-7c4f-4543-8886-3c1beeed78d5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f28896b2-a4f0-428f-a116-bf2477e4d09e",
"account_manager_user_code": "sample string 56",
"company_status_id": "bfd7ef58-292b-4c32-91da-ebe9fb6611b5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"id2": 60
},
"db_language_id": "cab66416-038f-42b5-a8da-3ccab67facd6",
"db_language_code": "sample string 7",
"db_title_id": "29d3093f-90de-4ec6-8c3a-484db66179a9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-09-16T08:21:46.0733086+00:00",
"create_date": "2023-09-16T08:21:46.0733086+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-09-16T08:21:46.0733086+00:00"
},
"modified_dateutc": "2023-09-16T08:21:46.0733086+00:00",
"id2": 22
}