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": "b46cff70-4cb8-452e-9d12-b8adde729a53",
  "is_client": true,
  "is_supplier": true,
  "archived": true,
  "name": "sample string 5",
  "notes": "sample string 6",
  "create_date": "2025-06-21T11:49:51.8644278+00:00",
  "sales_territory_id": "124bd198-662c-490f-a6b9-1ca30721b234",
  "sales_territory_code": "sample string 9",
  "sales_territory": {
    "id": "7d1caadf-03bd-491f-8aa1-eab64441ef46",
    "code": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "a1b7552d-dcec-4c50-bf1a-63ec2081b7bf",
    "sales_organization_code": "sample string 5",
    "sales_organization": {
      "id": "585ff735-039c-40ab-92e0-ce30e7abba8e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "883ebc0e-4071-42d9-81bd-5e081a069a7b",
      "db_currency_id": "797d7c83-7d85-44fc-b767-70a4db0c041d",
      "db_language_id": "42e87d80-3240-43b7-9f2c-840e98a7b6c3",
      "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-06-21T11:49:51.8644278+00:00"
    },
    "modified_dateutc": "2025-06-21T11:49:51.8644278+00:00"
  },
  "marketing_segment_id": "f1435f69-7e7f-4682-9111-3fd582450df2",
  "marketing_segment_code": "sample string 11",
  "sales_organization_id": "e6b2e4ea-d6f6-4f97-a7b3-2cf81c3085df",
  "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": "d24401de-047f-4622-b3bd-1fe0df47b957",
  "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": "262119c0-1d53-4dbf-9d4e-66015d38a7bf",
  "db_country_code": "sample string 28",
  "feelist_id": "8b65d031-d1d4-4e87-9cbf-349fe41402c6",
  "feelist_reference_back_office": "sample string 30",
  "feelist": {
    "id": "f0fd4677-2135-436e-a5ab-72c438a2b77b",
    "name": "sample string 2",
    "description": "sample string 3",
    "is_default": true,
    "default_price": 1.0,
    "sales_organization_id": "82d5d19a-e57e-4a03-9833-16068708c6ee",
    "sales_organization_code": "sample string 6",
    "reference_back_office": "sample string 7",
    "modified_dateutc": "2025-06-21T11:49:51.8644278+00:00",
    "db_currency_id": "34a21bd3-5e74-4e38-841b-9a5df3e9318f",
    "db_currency_code": "sample string 10"
  },
  "company_type_id": "20acf2c5-f006-4edc-9d85-a7309a1536ac",
  "company_type_name": "sample string 32",
  "company_type": {
    "id": "224201fc-6ff4-4a00-94b8-5f399ef7ef5d",
    "name": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "2986e2b1-ea0d-4c7b-9b67-73df4a7bd014",
    "sales_organization_code": "sample string 5"
  },
  "db_language_id": "c06ed487-8480-492f-b46d-744bc002b0e2",
  "db_language_code": "sample string 34",
  "code": "sample string 35",
  "article_price_label_id": "cb49314f-0d0f-4097-b4d6-678fb7ecae93",
  "article_price_label_code": "sample string 37",
  "db_payment_method_id": "5dd95012-3833-4fc4-a268-be4854c6f36d",
  "db_payment_method_reference_back_office": "sample string 39",
  "db_payment_methods": {
    "id": "6e5f8662-6b51-43fb-b938-36f6ec294cd5",
    "name": "sample string 2",
    "description": "sample string 3",
    "reference_back_office": "sample string 4",
    "activated": true,
    "modified_dateutc": "2025-06-21T11:49:51.8644278+00:00"
  },
  "company_sector_id": "b8cdf3f0-4ff0-4bb3-bcb7-7142540a944c",
  "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": "cb3cc424-4ba6-44c1-856a-a380acad4238",
  "service_manager_user_code": "sample string 52",
  "finance_manager_user_id": "f314b8c3-dcf8-4276-801f-debb7e0eaaa8",
  "finance_manager_user_code": "sample string 54",
  "account_manager_user_id": "1a09dcc8-47eb-44c4-b0bd-13fb4273148f",
  "account_manager_user_code": "sample string 56",
  "company_status_id": "8ab3fed6-ceb8-4a64-a7fe-100f6ef45cf7",
  "invoice_email_to": "sample string 58",
  "modified_dateutc": "2025-06-21T11:49:51.8644278+00:00",
  "id2": 60
}