Retrieves all the companies

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

company
NameDescriptionTypeAdditional 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

email

email

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

Sample:
{
  "id": "5353f4ca-d285-40e4-b0e1-8b4424552152",
  "is_client": true,
  "is_supplier": true,
  "archived": true,
  "name": "sample string 5",
  "notes": "sample string 6",
  "create_date": "2025-05-31T07:17:08.8843835+00:00",
  "sales_territory_id": "eec17308-a572-4658-88d1-08220e4d5be5",
  "sales_territory_code": "sample string 9",
  "sales_territory": {
    "id": "b62f47f7-42b0-43f7-8c10-72596598aa8e",
    "code": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "ea4377f2-cffd-4f72-b048-77cee6fb628a",
    "sales_organization_code": "sample string 5",
    "sales_organization": {
      "id": "0a00c41d-9402-42ec-8d51-a3ac3a5e842e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "4a6002c2-7380-4cad-b120-2b156a1ce136",
      "db_currency_id": "cea58bd7-25dc-4497-8cff-011654541e5c",
      "db_language_id": "9b323c4f-9b53-4c60-9d4c-93280f3098ae",
      "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-05-31T07:17:08.8843835+00:00"
    },
    "modified_dateutc": "2025-05-31T07:17:08.8843835+00:00"
  },
  "marketing_segment_id": "38126197-b6b3-456d-808f-9b84357adfe3",
  "marketing_segment_code": "sample string 11",
  "sales_organization_id": "c4d2171e-45c3-45f4-8bc9-20d4a860e7cc",
  "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": "5d3ac9b0-35f7-4dae-9e87-a1c1923f49c7",
  "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": "a9120032-72e8-4404-84af-da58d0f693f7",
  "db_country_code": "sample string 28",
  "feelist_id": "651a4255-3e94-4a88-969e-ba54f678a7c6",
  "feelist_reference_back_office": "sample string 30",
  "feelist": {
    "id": "223d1580-c8b3-4003-963a-ae1123748de8",
    "name": "sample string 2",
    "description": "sample string 3",
    "is_default": true,
    "default_price": 1.0,
    "sales_organization_id": "cca62d31-45f3-418b-9976-5977977f0749",
    "sales_organization_code": "sample string 6",
    "reference_back_office": "sample string 7",
    "modified_dateutc": "2025-05-31T07:17:08.9000086+00:00",
    "db_currency_id": "f12022ed-9ea6-4fda-b988-ca9505fa0c5a",
    "db_currency_code": "sample string 10"
  },
  "company_type_id": "fcf4bc28-4e62-4610-8a7d-d5e344a80129",
  "company_type_name": "sample string 32",
  "company_type": {
    "id": "b12c424b-2c3c-40cb-8694-46f02b157043",
    "name": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "54cbb151-8032-4e95-962f-22db9d0b2572",
    "sales_organization_code": "sample string 5"
  },
  "db_language_id": "7fc757ef-21c9-4ec7-a2f4-fe6474810844",
  "db_language_code": "sample string 34",
  "code": "sample string 35",
  "article_price_label_id": "8b9c7734-0d82-4aa0-9835-63738dc08f0c",
  "article_price_label_code": "sample string 37",
  "db_payment_method_id": "dc148499-f65f-4d64-9d99-c9a808328f47",
  "db_payment_method_reference_back_office": "sample string 39",
  "db_payment_methods": {
    "id": "e37780df-1e00-43e8-a896-ff26463d8da6",
    "name": "sample string 2",
    "description": "sample string 3",
    "reference_back_office": "sample string 4",
    "activated": true,
    "modified_dateutc": "2025-05-31T07:17:08.9000086+00:00"
  },
  "company_sector_id": "a0d2b4e2-f7f2-4862-801b-e78ba5417a90",
  "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": "2f9e5eb6-eabc-447c-b646-fc57d2844f38",
  "service_manager_user_code": "sample string 52",
  "finance_manager_user_id": "710cea16-7db0-44ef-8981-28b4b4ae148c",
  "finance_manager_user_code": "sample string 54",
  "account_manager_user_id": "80e82561-9b59-4f6f-ae1f-67e0e7d907d8",
  "account_manager_user_code": "sample string 56",
  "company_status_id": "987a9abe-b356-4ccc-81e6-6496c53c2ead",
  "invoice_email_to": "sample string 58",
  "modified_dateutc": "2025-05-31T07:17:08.9000086+00:00",
  "id2": 60
}