Company

Search Companies

HTTP Request

POST /api/companies/search

📋 Description: Submits a search request to locate companies based on specified criteria, enabling users to efficiently identify potential business partners or clients.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the search results for companies should be returned in a paginated format, facilitating efficient data retrieval and management.

body

body

CompanySearchFilter

true

Request body containing search criteria for company profiles, including filters such as industry, location, and company size to facilitate targeted business inquiries.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "countryIdEqual": 0,
30  "countryDisplayIdLike": "string",
31  "postingPeriodVariantIdEqual": 0,
32  "nameLike": "string",
33  "postingPeriodVariantDisplayIdLike": "string",
34  "controllingAreaIdEqual": 0,
35  "controllingAreaDisplayIdLike": "string",
36  "chartOfAccountIdEqual": 0,
37  "chartOfAccountDisplayIdLike": "string",
38  "fiscalVariantIdEqual": 0,
39  "fiscalVariantDisplayIdLike": "string",
40  "chartOfDepreciationIdEqual": 0,
41  "chartOfDepreciationDisplayIdLike": "string",
42  "purchasingOrganizationIdEqual": 0,
43  "assetIdEqual": 0,
44  "exchangeRateTypeIdEqual": 0,
45  "plantIdEqual": 0,
46  "incrementalBorrowingRateIdEqual": 0,
47  "businessUnitIdEqual": 0,
48  "projectIdEqual": 0,
49  "transferVariantIdEqual": 0,
50  "partnerIdEqual": 0,
51  "departmentIdEqual": 0,
52  "accountingStandardIdEqual": 0,
53  "generalLedgerAccountIdEqual": 0,
54  "consumerPriceIndexCategoryIdEqual": 0,
55  "costCenterIdEqual": 0,
56  "costCenterRelationValidFromEqual": "2019-08-24",
57  "costCenterRelationValidFromGreaterThanOrEqual": "2019-08-24",
58  "costCenterRelationValidFromLessThanOrEqual": "2019-08-24",
59  "costCenterRelationValidToEqual": "2019-08-24",
60  "costCenterRelationValidToGreaterThanOrEqual": "2019-08-24",
61  "costCenterRelationValidToLessThanOrEqual": "2019-08-24",
62  "searchTerm": "string"
63}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCompanyDto

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "first": true,
18  "last": true,
19  "size": 0,
20  "content": [
21    {
22      "id": 0,
23      "status": "CREATED",
24      "displayId": "string",
25      "erpSystemId": 0,
26      "erpSystemDisplayId": "string",
27      "countryId": 0,
28      "countryDisplayId": "string",
29      "postingPeriodVariantId": 0,
30      "name": "string",
31      "postingPeriodVariantDisplayId": "string",
32      "controllingAreaId": 0,
33      "controllingAreaDisplayId": "string",
34      "chartOfAccountId": 0,
35      "chartOfAccountDisplayId": "string",
36      "fiscalVariantId": 0,
37      "fiscalVariantDisplayId": "string",
38      "chartOfDepreciationId": 0,
39      "chartOfDepreciationDisplayId": "string",
40      "purchasingOrganizationId": 0,
41      "assetId": 0,
42      "exchangeRateTypeId": 0,
43      "plantId": 0,
44      "incrementalBorrowingRateId": 0,
45      "businessUnitId": 0,
46      "projectId": 0,
47      "transferVariantId": 0,
48      "partnerId": 0,
49      "departmentId": 0,
50      "accountingStandardId": 0,
51      "generalLedgerAccountId": 0,
52      "consumerPriceIndexCategoryId": 0,
53      "costCenterId": 0,
54      "costCenterRelationValidFrom": "2019-08-24",
55      "costCenterRelationValidTo": "2019-08-24"
56    }
57  ],
58  "number": 0,
59  "sort": {
60    "unsorted": true,
61    "sorted": true,
62    "empty": true
63  },
64  "empty": true
65}

Get Company

HTTP Request

GET /api/companies/{id}

📋 Description: Retrieves detailed information about a specific company identified by its unique ID, enabling users to access essential business data for analysis and decision-making.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CompanyDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "countryId": 0,
 8  "countryDisplayId": "string",
 9  "postingPeriodVariantId": 0,
10  "name": "string",
11  "postingPeriodVariantDisplayId": "string",
12  "controllingAreaId": 0,
13  "controllingAreaDisplayId": "string",
14  "chartOfAccountId": 0,
15  "chartOfAccountDisplayId": "string",
16  "fiscalVariantId": 0,
17  "fiscalVariantDisplayId": "string",
18  "chartOfDepreciationId": 0,
19  "chartOfDepreciationDisplayId": "string",
20  "purchasingOrganizationId": 0,
21  "assetId": 0,
22  "exchangeRateTypeId": 0,
23  "plantId": 0,
24  "incrementalBorrowingRateId": 0,
25  "businessUnitId": 0,
26  "projectId": 0,
27  "transferVariantId": 0,
28  "partnerId": 0,
29  "departmentId": 0,
30  "accountingStandardId": 0,
31  "generalLedgerAccountId": 0,
32  "consumerPriceIndexCategoryId": 0,
33  "costCenterId": 0,
34  "costCenterRelationValidFrom": "2019-08-24",
35  "costCenterRelationValidTo": "2019-08-24"
36}