Creates a new company
Request Information
URI Parameters :
None.
Body Parameters :
company| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| is_client |
SALES : Indicate if can be used for ordering |
boolean | |
| is_supplier |
SERVICES : indicate if this company is a supplier |
boolean | |
| archived |
Archive this company to not have it anymore on the search |
boolean | |
| name | string |
Required Max length: 64 |
|
| notes |
Notes/Remark field |
string | |
| create_date |
Creation date+time |
date | |
| sales_territory_id |
Territory of the company (Sales+Services).If more than one sales_territory exists, then it must be filled |
globally unique identifier | |
| sales_territory_code |
Embedded entity "sales_territory" using ERP PK when adding/updating company |
string | |
| sales_territory |
Embedded entity "sales_territory" using node when adding/updating company |
sales_territory | |
| marketing_segment_id |
Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) ) |
globally unique identifier | |
| marketing_segment_code |
Embedded entity "marketing_segment" using ERP PK when adding/updating company |
string | |
| marketing_segment |
Embedded entity "marketing_segment" using node when adding/updating company |
marketing_segment | |
| sales_organization_id |
Organization on which belongs the company.If more than one sales_organization exists, then it must be filled |
globally unique identifier | |
| sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating company |
string | |
| sales_organization |
Embedded entity "sales_organization" using node when adding/updating company |
sales_organization | |
| company_sales_status_code |
Foreign key of company_sales_status using code. Use "Normal,CreditRisk, BlockedbyCM or OrderBlocked" |
string | |
| vat_reg_code |
VAT number |
string |
Max length: 50 |
| is_working_address |
Services : If False, you cannot create project/installation on this company.Default=true |
boolean | |
| parent_id |
Reference to a parent company (in case of Child/Parent) when adding/updating company |
globally unique identifier | |
| parent_company_code |
Embedded entity "company" for parent (in case of Child/Parent) using ERP PK when adding/updating company |
string | |
| parent_company |
Embedded entity "company" for parent (in case of Child/Parent) when adding/updating company |
company | |
| phone |
Phone number of the company |
string |
Max length: 50 |
| fax |
Fax number of the company |
string |
Max length: 50 |
| url |
URL of the company website |
string |
Max length: 255 |
|
|
string |
Max length: 250 |
|
| street |
Address:Street |
string |
Max length: 100 |
| street_number |
Address:Street Number. If your ERP doesn't have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number |
string |
Max length: 50 |
| city |
Address:City |
string |
Max length: 50 |
| zip |
Address:Zip |
string |
Max length: 50 |
| db_country_id |
Address:Country |
globally unique identifier | |
| db_country_code |
Address:CountryCode entity using international code when adding/updating company |
string | |
| feelist_id |
FeeList activated for the company (On Service, Feelist determines the price of the invoicable timesheets) |
globally unique identifier | |
| feelist_reference_back_office |
Embedded entity "feelist" using ERP PK when adding/updating company |
string | |
| feelist |
Embedded entity "feelist" using node when adding/updating company |
feelist | |
| company_type_id |
Company Type |
globally unique identifier | |
| company_type_name |
Embedded entity "company_type" using ERP PK when adding/updating company |
string | |
| company_type |
Embedded entity "company_type" using node when adding/updating company |
company_type | |
| db_language_id |
Language of the company.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating company |
string | |
| code |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| article_price_label_id |
Foreign key of article price label |
globally unique identifier | |
| article_price_label_code |
Embedded entity "article price label" using ERP PK when adding/updating |
string | |
| article_price_label |
Embedded entity "article price label" when adding/updating |
article_price_label | |
| db_payment_method_id |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
globally unique identifier | |
| db_payment_method_reference_back_office |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
string | |
| db_payment_methods |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
db_payment_methods | |
| company_sector_id |
Foreign key to company_sector |
globally unique identifier | |
| company_sector_code |
Embedded code for the company_sector using ERP PK when adding/updating |
string | |
| company_sector |
Embedded entity for the company_sector using the key from an external system when adding/updating object |
company_sector | |
| is_lead |
Indicate that company is not already a customer |
boolean | |
| is_subcontractor |
For Service, that company is one of your subcontractors |
boolean | |
| latitude |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| street2 |
Additional information on the address not part of the postal address |
string | |
| bic_code |
bic code |
string | |
| specialities |
specialities |
string | |
| register_number |
register_number |
string | |
| register_city |
register_city |
string | |
| bankaccount |
Bank account of the company. |
string | |
| mobile |
Mobile number of the company |
string |
Max length: 50 |
| service_manager_user_id |
ID of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
globally unique identifier | |
| service_manager_user_code |
Embedded code of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
string | |
| service_manager_user |
Embedded entity of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
user | |
| finance_manager_user_id |
ID of the finance manager. Only used inside communication and tags |
globally unique identifier | |
| finance_manager_user_code |
Embedded code of the finance manager. Only used inside communication and tags |
string | |
| finance_manager_user |
Embedded entity of the finance manager. Only used inside communication and tags |
user | |
| account_manager_user_id |
ID of the account manager. Only used inside communication and tags |
globally unique identifier | |
| account_manager_user_code |
Embedded code of the account manager. Only used inside communication and tags |
string | |
| account_manager_user |
Embedded entity of the account manager. Only used inside communication and tags |
user | |
| company_status_id |
Company Status |
globally unique identifier | |
| invoice_email_to |
Email to send invoice |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric) |
integer |
Request Formats :
application/json, text/json
{
"id": "5e6ee639-b76f-4f3d-a7c7-cad88e09c39c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T09:17:21.8621436+00:00",
"sales_territory_id": "ba9ded94-775c-4596-9946-62be194370c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "14409d6c-a1a9-43a7-8fe4-907f5899da24",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb174e65-a01d-42c1-a897-2031ba68e503",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a8fdd73-3dca-4019-a936-afdca7cfa05b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd55766b-7792-4dd9-9e7d-0b396cb6d7a4",
"db_currency_id": "1ac25b0d-d701-43a1-9dcc-349623effbb5",
"db_language_id": "99b57141-83cf-44e9-a29f-aec38c6a1897",
"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-18T09:17:21.8621436+00:00"
},
"modified_dateutc": "2026-09-18T09:17:21.8621436+00:00"
},
"marketing_segment_id": "115646c7-77ef-4715-9a8c-bcd1f27daf5e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0795fff9-8bf5-4122-9f3b-407aeb06679b",
"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": "4489ec05-1511-4d3e-b309-c1e9a2be1faa",
"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": "4b829200-fde1-46d7-81f8-2c95e8bd7f00",
"db_country_code": "sample string 28",
"feelist_id": "0867fac7-c7db-4635-bb1d-15ace0abdd21",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cab1b9f3-d00a-4ab0-a832-ffce54c6f51e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "957f2c6b-a02c-4a02-bdc1-9829cdfe6be9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T09:17:21.8621436+00:00",
"db_currency_id": "a05eb448-1c2c-4159-bb0c-77c215f99ec0",
"db_currency_code": "sample string 10"
},
"company_type_id": "d0beb068-7a37-4605-bf3e-79ecc137e23f",
"company_type_name": "sample string 32",
"company_type": {
"id": "4bda7969-b701-4b2f-82ea-a19122d1e51d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "837dde35-6397-4044-b38f-7288efc077ea",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ca89dd8a-887f-4215-87dd-a15d93e34870",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1f4da6ca-e0db-4dd4-803a-68d52cb29b9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5e4dca15-9e2e-4edc-9e59-942fc285eb3c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a04f282-e391-4fb4-a1a5-e16ec6c59a4f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T09:17:21.8621436+00:00"
},
"company_sector_id": "55ff0301-9722-4b7c-b2cb-63834cdf6ebd",
"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": "23ed267b-e7ac-4962-8f7d-ad788656c144",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "182fb624-1bb5-46e7-9952-2fc90eaa1df9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77361122-7d99-4b88-97bb-5124b23abf5a",
"account_manager_user_code": "sample string 56",
"company_status_id": "ae565ba9-baea-42f3-9a37-99e6d347eb2f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T09:17:21.8621436+00:00",
"id2": 60
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.