CompanySearchRequest

Example Json Object

 1{
 2  "searchTerm": "string",
 3  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 4  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 5  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 6  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 7  "createdByLike": "string",
 8  "createdByEqual": "string",
 9  "statusEqual": "CREATED",
10  "statusIn": [
11    "CREATED"
12  ],
13  "erpSystemIdIn": [
14    0
15  ],
16  "erpSystemIdEqual": 0,
17  "erpSystemDisplayIdIn": [
18    "string"
19  ],
20  "idIn": [
21    0
22  ],
23  "displayIdIn": [
24    "string"
25  ],
26  "leaseAreaIdIn": [
27    0
28  ],
29  "businessUnitIdIn": [
30    0
31  ],
32  "businessUnitIdEqual": 0,
33  "fiscalVariantIdIn": [
34    0
35  ],
36  "fiscalVariantIdEqual": 0,
37  "companyCommonCurrencySearchTerm": "string",
38  "countryDisplayIdLike": "string",
39  "partnerIdEqual": 0,
40  "displayIdLike": "string"
41}

📄 Description: Data transfer object representing a request to search for companies within the system, enabling users to efficiently locate and retrieve relevant business information based on specified criteria.

Properties

Name

Type

Required

Restrictions

Description

searchTerm

string

false

none

The searchTerm field represents the keyword or phrase used to query the company database, enabling users to efficiently locate specific company information.

createdAtGreaterThanOrEqual

string(date-time)

false

none

Filter where created at is greater than or equal to specified value

createdAtLessThanOrEqual

string(date-time)

false

none

Filter where created at is less than or equal to specified value

modifiedAtGreaterThanOrEqual

string(date-time)

false

none

Filter where modified at is greater than or equal to specified value

modifiedAtLessThanOrEqual

string(date-time)

false

none

Filter where modified at is less than or equal to specified value

createdByLike

string

false

none

Filter by partial match of created by

createdByEqual

string

false

none

Filter by exact match of created by

statusEqual

string

false

none

Filter by exact match of status

statusIn

[string]

false

none

Filter by multiple values of status

erpSystemIdIn

[integer]

false

none

Filter by multiple values of erp system id

erpSystemIdEqual

integer(int64)

false

none

Filter by exact match of erp system id

erpSystemDisplayIdIn

[string]

false

none

Filter by multiple values of erp system display id

idIn

[integer]

false

none

Filter by multiple values of id

displayIdIn

[string]

false

none

Filter by multiple values of display id

leaseAreaIdIn

[integer]

false

none

Filter by multiple values of lease area id

businessUnitIdIn

[integer]

false

none

Filter by multiple values of business unit id

businessUnitIdEqual

integer(int64)

false

none

Filter by exact match of business unit id

fiscalVariantIdIn

[integer]

false

none

Filter by multiple values of fiscal variant id

fiscalVariantIdEqual

integer(int64)

false

none

Filter by exact match of fiscal variant id

companyCommonCurrencySearchTerm

string

false

none

Search term used to identify and filter companies based on their common currency in financial transactions.

countryDisplayIdLike

string

false

none

Filter by partial match of country display id

partnerIdEqual

integer(int64)

false

none

Filter by exact match of partner id

displayIdLike

string

false

none

Filter by partial match of display id

Enumerated Values

Attribute

Value

statusEqual

ACTIVE, CREATED, DECOMMISSIONED, DISABLED