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": "dc0d485a-2100-4333-a465-82ff1d8c4733",
"_parent_id": "aab2e6e9-6ce4-449d-80cb-c0c1463ee824",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ac09ff96-467e-4dd1-9fee-2cffd4187436",
"company_id": "d2ea35dd-59d8-4099-9168-bb5e0eda9700",
"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": "1f697686-6192-495b-aab6-726d28227b6d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "96adecb9-6cfe-4a59-8068-fae2f199f470",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c562c94e-acdf-45c1-8527-20aa0e7c105f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eb4f4173-9530-4e52-a9c0-d5137f8a5cbf",
"company_code": "sample string 5",
"company": {
"id": "f7ea04df-758e-418b-bd0c-4fc5705872dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-02T07:11:57.4786683+00:00",
"sales_territory_id": "429e100a-7277-4dfc-aff9-292f805f4a4e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3eec4b71-28a5-4c0d-aa58-dd54940728ca",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "810f7fb2-c588-49bd-8ffe-6b0da0a5057e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63c51831-58fc-4ea6-b578-55d6983d0252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b96d99b-e482-43b3-b0da-08f27dc9b98f",
"db_currency_id": "a1ba3ca7-6366-44a8-8f71-27db446fb4b1",
"db_language_id": "3589c923-fddd-4855-95d3-11451f64d300",
"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": "2025-04-02T07:11:57.4942901+00:00"
},
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00"
},
"marketing_segment_id": "47821a18-1b1b-453d-b694-4b213f74fec7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c3dafa1-1303-46a0-af09-856f7e64ee43",
"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": "38bd516d-8377-49bd-8267-1a33c204e48e",
"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": "6a5bdc62-4cd9-4306-92fe-228d41b7f9f5",
"db_country_code": "sample string 28",
"feelist_id": "d6e306d1-52b5-47c2-9c81-a6c4cd97ad78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d47b46fc-73a7-4292-a561-7348162c36f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54437505-cdec-4ac3-bc1a-bee990d8e194",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00",
"db_currency_id": "206a70c8-5717-455a-9b10-9c81488f3ee3",
"db_currency_code": "sample string 10"
},
"company_type_id": "82efc992-fbee-4e35-9fac-ad4419f5a535",
"company_type_name": "sample string 32",
"company_type": {
"id": "6822ec1d-9625-4b6d-b1de-5f7492231dac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aff1d238-71c0-4918-a478-b94efcfe0b4b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "340f2d0a-9e81-474e-927e-43ae83e02552",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "69f5a80e-ddfc-408e-b794-f4b3d09675de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c8ee22ac-609c-42a1-884a-b1a18199e0eb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4eca71ae-5adf-480b-9dea-ff1570b9b03e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00"
},
"company_sector_id": "eb880c3a-60ae-481d-b3a7-1a1c2dd6f4b8",
"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": "3704921e-a39f-449f-9d67-c23feb509ca1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a435919a-63b5-4374-80bb-2d4692f5296c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bf477a79-4d55-446b-91d1-111793ab6750",
"account_manager_user_code": "sample string 56",
"company_status_id": "4810390a-b97e-4bae-a653-95209e39f9b0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00",
"id2": 60
},
"db_language_id": "b422100e-874e-43c6-b6c0-3b25a894889f",
"db_language_code": "sample string 7",
"db_title_id": "1f414ef3-219a-4ff6-a981-6dbb7649456f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-02T07:11:57.4942901+00:00",
"create_date": "2025-04-02T07:11:57.4942901+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": "2025-04-02T07:11:57.4942901+00:00"
},
"modified_dateutc": "2025-04-02T07:11:57.4942901+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": "4c996f5c-605f-4275-a221-e47adf9da2bf",
"_parent_id": "f7b73757-a49a-432e-b385-319c72da112b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ad7b1c8c-f27f-4199-8998-73685d59ac3c",
"company_id": "50d9c354-785a-4e1a-975b-05239e1aa3dc",
"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": "5e07d58e-0fd2-4cc3-a036-aa71c039d18a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cf5ee22b-a348-4a8a-a1e7-608a65f2d349",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fb2a2138-198e-44dd-96a1-a37d44c5e682",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a11d57fa-953e-41da-bf42-93d0f6fec3f7",
"company_code": "sample string 5",
"company": {
"id": "f3644730-344b-42ce-99b6-300e2d0b1a2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-02T07:11:57.4942901+00:00",
"sales_territory_id": "60a7f761-4827-4a94-a326-c57037fd2105",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "14d627e7-27ed-46ed-9216-7d8c70455b33",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b6077ec8-2c8f-42b6-aee2-2912773680b1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94a455ce-377b-4910-87bb-c9dac3f62475",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef636792-4375-4429-abdb-fdbc776b4cff",
"db_currency_id": "01e38211-452e-4385-837d-415ecc675800",
"db_language_id": "27e25a59-e8f3-4740-affd-11a21e747ea4",
"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": "2025-04-02T07:11:57.4942901+00:00"
},
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00"
},
"marketing_segment_id": "0beb19c5-e4ab-4b3d-878e-f6f7f5b217a7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e99a1ca2-239a-455a-8015-d06a7ad2d8e1",
"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": "ea8ba930-2c57-4b13-94e4-eb04127bc435",
"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": "ff8bd1e8-32ee-441e-bf3c-1e54791f1cd5",
"db_country_code": "sample string 28",
"feelist_id": "2b19a262-10c5-42e0-92c2-56f4be8355ff",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e30dc003-eefb-44f8-8bb6-3289cb1ba2fd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9916d3f5-7add-43ee-a5a6-207b0c6d1c03",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-02T07:11:57.4942901+00:00",
"db_currency_id": "8e7ea101-19b8-4cfa-bc33-0b6502f8be79",
"db_currency_code": "sample string 10"
},
"company_type_id": "759217df-def5-4a09-86b5-756ed823d4b2",
"company_type_name": "sample string 32",
"company_type": {
"id": "709fb56d-2be0-4d1e-ac0d-d43533cce5a2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e945c56d-c695-4971-934a-cf1d0852c1ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "99f141bc-f601-4780-8019-7b040a0a052f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "39725122-759e-44e6-aa26-4a5f1652e53f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71c51bb5-bd55-4949-9e63-9d8c97909d77",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40a48f0e-d940-4ae1-b893-5f194a1d46c0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-02T07:11:57.5099179+00:00"
},
"company_sector_id": "cbb3dc23-4519-4438-9900-cc91dee59729",
"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": "565a8ea9-e49a-44cd-9865-1277cd6102b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a436cafe-4a21-4347-a20f-b0b98ebba40f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff6e60c4-9643-47fa-86de-879e26df1df7",
"account_manager_user_code": "sample string 56",
"company_status_id": "8c977535-8c8b-4a3b-aac4-d2ee49e01857",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-02T07:11:57.5099179+00:00",
"id2": 60
},
"db_language_id": "535fbd93-4e3f-436d-8ac4-ab85de01cb48",
"db_language_code": "sample string 7",
"db_title_id": "d7c1cd86-fd30-4847-8b72-cd693cb4e57a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-02T07:11:57.5099179+00:00",
"create_date": "2025-04-02T07:11:57.5099179+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": "2025-04-02T07:11:57.5099179+00:00"
},
"modified_dateutc": "2025-04-02T07:11:57.5099179+00:00",
"id2": 22
}