PartnerSearchRequest

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  "idNotIn": [
24    0
25  ],
26  "leaseAreaIdIn": [
27    0
28  ],
29  "businessUnitIdIn": [
30    0
31  ],
32  "companyIdIn": [
33    0
34  ],
35  "companyIdEqual": 0,
36  "partnerRoleIdIn": [
37    0
38  ],
39  "partnerRoleIdEqual": 0,
40  "displayIdEqual": "string"
41}

📄 Description: Data transfer object representing a request to search for partners within the General Ledger, facilitating the retrieval of relevant ledger entries, transactions, accounts, and financial records.

Properties

Name

Type

Required

Restrictions

Description

searchTerm

string

false

none

Search term used to filter and retrieve specific ledger entries, transactions, accounts, or financial records within the General Ledger API.

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

idNotIn

[integer]

false

none

Filter by excluding multiple values of 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

companyIdIn

[integer]

false

none

Filter by multiple values of company id

companyIdEqual

integer(int64)

false

none

Filter by exact match of company id

partnerRoleIdIn

[integer]

false

none

Filter by multiple values of partner role id

partnerRoleIdEqual

integer(int64)

false

none

Filter by exact match of partner role id

displayIdEqual

string

false

none

none

Enumerated Values

Attribute

Value

statusEqual

ACTIVE, CREATED, DECOMMISSIONED, DISABLED