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": "1aada9e5-12d7-41be-8ee6-c3621c3651b9",
"_parent_id": "ab266963-7780-4156-ab25-e4628eed2ca5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8815e11c-a7ff-4b90-92c2-e80134720e80",
"company_id": "1e054d5e-bd36-4104-91ce-c7e87c1cb03f",
"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": "f8812a66-32f9-4f5b-990b-1b68790e7a1c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "da541090-cd37-4e0a-bda1-a35f4a37ef84",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "caf42d7a-1efa-440d-b26e-daeb0c7e014e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86d523b8-e419-4ea5-8d52-c2b88cdd5d77",
"company_code": "sample string 5",
"company": {
"id": "d340a1a3-b09a-4d49-b19d-e3531defba23",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-30T13:47:39.5851017+00:00",
"sales_territory_id": "50ea1786-c62a-484d-95ae-b034d4b483ab",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a49f813-8f39-4a43-b3a0-fe80cb433f3a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "13a039d1-47f8-433d-81e4-ec49995d8e1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a52747c9-f0b2-4423-b90f-e9dbb80c54b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "050bd2b1-f19c-430e-a7ad-714af85202ce",
"db_currency_id": "ecac74b5-30f7-4a5a-bf49-749a2508652b",
"db_language_id": "8d9f14aa-6a96-4e64-b15e-fb165f9c216a",
"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-10-30T13:47:39.5851017+00:00"
},
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00"
},
"marketing_segment_id": "ed2d163c-6fe1-4944-b1f7-e48740585b1a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5d8982ea-0794-47fd-9143-82973c342679",
"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": "5b457f7b-8b0d-431f-b808-bf536a2e4192",
"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": "4e33e8aa-c1c6-4528-a6b0-200482e05f5d",
"db_country_code": "sample string 28",
"feelist_id": "8eeb50b5-5c45-4fa3-a1c4-872c10ede02d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "50c999aa-5ef1-4a14-bf97-498344f195a8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ec39e9e-cb66-417b-b87b-ee1594c61d28",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00",
"db_currency_id": "885ec75f-9eb8-4b89-b79b-f49b04321d5b",
"db_currency_code": "sample string 10"
},
"company_type_id": "c3a4688d-ea74-4e01-b071-a29ae9e7a176",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c7bcd8d-a12e-446c-85bd-603172b4c13a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db6824e4-7e97-4107-b936-a0003c99c2db",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d57eb9f3-95c9-4c8e-935f-58ba5d34748b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62cd0003-b904-468f-a80a-77c490ffc918",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99352a68-ee31-4b07-843b-44c0effc71f4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fb4facb5-196d-4592-a561-23d273f6fc7f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00"
},
"company_sector_id": "eb59eafe-cb40-473b-aed0-76f2beba9fee",
"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": "96260cc4-e231-407f-9551-ac89203d495c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "78dcac95-32fd-4918-9afd-6e212dde9a63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cdd9d3ae-8581-4ee6-bedf-2ecdbc13d807",
"account_manager_user_code": "sample string 56",
"company_status_id": "54d04039-e197-455e-bf37-d8e00b8f4c3e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00",
"id2": 60
},
"db_language_id": "787c35e3-c68a-44a5-be7e-a86861a60703",
"db_language_code": "sample string 7",
"db_title_id": "84006071-b082-41fa-ad0c-bbf5dc8e9ff8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-30T13:47:39.5851017+00:00",
"create_date": "2025-10-30T13:47:39.5851017+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-10-30T13:47:39.5851017+00:00"
},
"modified_dateutc": "2025-10-30T13:47:39.5851017+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": "cb5af74f-0b60-4fc7-a7da-003ce2db7dbc",
"_parent_id": "4632caf4-38ed-4f1f-829e-2d6e502dc5dc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cc878382-5498-400c-9c8e-34f59e1b20ed",
"company_id": "39f8de2e-1d41-4bf2-8cd6-96ab0fbc5b48",
"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": "47012887-2e36-434f-86be-37d8bfedf0d3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "571a7adf-47a7-4495-b5b1-c41baca556c2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "184683a9-e7bb-4825-81c9-30cbee3121d9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c27fae01-0d97-4216-8856-d797488e3f75",
"company_code": "sample string 5",
"company": {
"id": "524a8ff2-927d-4850-9799-f217ceff2c65",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-30T13:47:39.5851017+00:00",
"sales_territory_id": "72011604-b0cf-4a6a-abfd-97fffc79dfb1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "908a8299-2daf-4fce-bd0a-ad0ea3a7b070",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b358566-36c5-4654-8667-127ddc54a43d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a838d834-ac66-4799-b92e-539d3e5e1e93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b00753c-f7f7-4afe-8553-5391ec5a460f",
"db_currency_id": "44c35f09-70a8-4e86-823a-8df718c0b2b0",
"db_language_id": "2bfebd78-7eaa-49b2-a505-51cf45502007",
"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-10-30T13:47:39.5851017+00:00"
},
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00"
},
"marketing_segment_id": "b2d9f98f-8f51-4816-a2a1-c7d74c911951",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8739dce6-8d08-4394-b111-a488e926b64b",
"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": "9d03f9bc-18a9-4dda-838b-103109bdc692",
"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": "80c4a9e2-141c-43ce-bdcb-b7bdfa42a345",
"db_country_code": "sample string 28",
"feelist_id": "c8097d4c-ad58-4714-aca0-1b31724016a0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "551da986-fe74-4201-8495-d213e9fe8b79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "acf7c6ed-b766-4718-b05b-fd61f7223997",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00",
"db_currency_id": "39ae3091-ccbf-407e-ba0d-a2ff3c2486bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "f9b730f1-6382-4dad-9ac4-d0db7cc59258",
"company_type_name": "sample string 32",
"company_type": {
"id": "562519d2-4d52-4e44-a5d0-4962210c9c9b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a84de021-0e63-493d-8e30-be4852533cb6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1a347135-6359-4d46-98d7-a264a1f2c64a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "50911eb2-94b5-4162-9808-66e1e2b2165f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e4d86a25-d9c7-4a68-80e8-3c48c5efd531",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1bddb2a7-7cd4-4f7c-af97-e4dc7a56156c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00"
},
"company_sector_id": "538929d2-b636-4663-a90f-6c299ce9f0b0",
"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": "da23c524-0f6b-4b2c-94e2-c58d929c2c51",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c0da5a80-726d-4d1e-a2e9-fff012de91c9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0bc91b25-13fe-49ef-8a91-ac9397d0a703",
"account_manager_user_code": "sample string 56",
"company_status_id": "ec99a5e3-cdf3-4aef-8b02-2adcf8212c36",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00",
"id2": 60
},
"db_language_id": "1c7d4c8b-8562-46c6-b8e4-bc66ecf2145f",
"db_language_code": "sample string 7",
"db_title_id": "c8bdd37b-56cb-4bf5-90a5-04a723517854",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-30T13:47:39.5851017+00:00",
"create_date": "2025-10-30T13:47:39.5851017+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-10-30T13:47:39.5851017+00:00"
},
"modified_dateutc": "2025-10-30T13:47:39.5851017+00:00",
"id2": 22
}