Retrieves the company with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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 |
Response Formats
application/json, text/json
{
"id": "2ea0a9a1-734b-4291-affe-e4251ad6f8d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-18T22:33:57.8650497+00:00",
"sales_territory_id": "e5dd3e81-5e6c-403d-ab5f-b4accc77560f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "07a14058-7c3f-47a5-b49b-4fd3c1579e76",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80344aa6-8d4e-4039-b6d0-0421bae50ad0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "836cacd8-b769-4e3d-bc2e-5b47b768967e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26b2e2c3-4503-4b85-ad10-70371c977b55",
"db_currency_id": "3dbffa68-9bd4-44b3-8836-21ac4c34fbe3",
"db_language_id": "dfcf5c9d-d5af-4590-acf8-7d91d4eae3bf",
"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-02-18T22:33:57.8650497+00:00"
},
"modified_dateutc": "2025-02-18T22:33:57.8650497+00:00"
},
"marketing_segment_id": "3513139e-24ab-4fef-a1ee-d6268af8b46d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6dd178f3-041e-4995-90db-1a3e4a08d39b",
"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": "1deba6fb-beec-4a40-85c9-c620e1b2037e",
"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": "e57172cb-54ae-4d00-91d9-a70058812430",
"db_country_code": "sample string 28",
"feelist_id": "57a96bbc-a000-4cb8-b0e8-e8a2819898d8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "26fdc7d5-9540-4e40-a1b2-f5bc5913823f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7a63badf-ad0e-4482-ba51-e324291accad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-18T22:33:57.8650497+00:00",
"db_currency_id": "42ee9139-1be7-424a-b46f-8bee4a57ad8a",
"db_currency_code": "sample string 10"
},
"company_type_id": "88bfa995-b660-41b1-b5c6-0a88b66cf190",
"company_type_name": "sample string 32",
"company_type": {
"id": "47d350e8-ec91-4225-a452-7eb3045ca5d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7eaa4b8-7b0d-4741-95da-85b36bec32ae",
"sales_organization_code": "sample string 5"
},
"db_language_id": "834f1aef-0206-413a-9382-555b2895d2ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e6afdd68-64ed-4741-af47-75a1648ef2dc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f9bb95d-0e9d-4077-9eab-eec6ef803725",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dabb64b5-3d31-4d15-be6a-835b7eafc8b9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-18T22:33:57.8808781+00:00"
},
"company_sector_id": "1a68f02b-ef47-425e-8ba5-80854bb54244",
"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": "a40d0e92-088b-4bae-a65e-4793725a8e0d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1c1e0254-7161-42a9-92e4-4ac449ec0e23",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fa346d53-74f4-4ef4-9394-c28af79db3f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "fe1ed79b-be9e-4b4f-90fd-2622dd5ec906",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-18T22:33:57.8808781+00:00",
"id2": 60
}