GLPaymentClearingSearchRequest

Example Json Object

 1{
 2  "requestUniqueId": "string",
 3  "companyIds": [
 4    0
 5  ],
 6  "vendorId": 0,
 7  "vendorIds": [
 8    0
 9  ],
10  "allVendorsSelected": true,
11  "fiscalYear": 0,
12  "fiscalPeriod": 0,
13  "fromAmount": 0,
14  "toAmount": 0,
15  "availableAmountFrom": 0,
16  "availableAmountTo": 0,
17  "taxAmountFrom": 0,
18  "taxAmountTo": 0,
19  "totalAmountFrom": 0,
20  "totalAmountTo": 0,
21  "fromPaymentDate": "2019-08-24",
22  "toPaymentDate": "2019-08-24",
23  "currencyId": 0,
24  "postingDateFrom": "2019-08-24",
25  "postingDateTo": "2019-08-24",
26  "contractDisplayId": "string",
27  "leaseDisplayId": "string",
28  "tag": "string",
29  "ledgerEntryIds": [
30    0
31  ],
32  "ledgerEntryIdsNotIn": [
33    0
34  ]
35}

📄 Description: Data transfer object representing a request for searching GL payment clearing records, enabling users to efficiently retrieve and analyze financial transactions within the general ledger.

Properties

Name

Type

Required

Restrictions

Description

requestUniqueId

string

true

none

Unique identifier for the request unique

companyIds

[integer]

false

none

An array of unique identifiers representing the companies associated with the payment clearing search request.

vendorId

integer(int64)

false

none

Unique identifier for the vendor

vendorIds

[integer]

false

none

List of unique identifiers for vendors associated with the payment clearing request, enabling targeted searches within the GLPaymentClearing framework.

allVendorsSelected

boolean

false

none

Indicates whether all vendors have been selected for the payment clearing search request.

fiscalYear

integer(int32)

false

none

Represents the fiscal year for which payment clearing data is being requested, facilitating accurate financial reporting and analysis.

fiscalPeriod

integer(int32)

false

none

Represents the fiscal period for which payment clearing data is being requested, enabling precise financial reporting and analysis.

fromAmount

number

false

none

Amount of from

toAmount

number

false

none

Amount of to

availableAmountFrom

number

false

none

Specifies the minimum available amount for processing GL payment clearing requests.

availableAmountTo

number

false

none

Represents the total amount available for allocation in the payment clearing process.

taxAmountFrom

number

false

none

Specifies the total tax amount applicable to the payment clearing request, facilitating accurate financial reporting and compliance.

taxAmountTo

number

false

none

Specifies the total tax amount to be applied in the payment clearing process.

totalAmountFrom

number

false

none

Represents the total amount from which payments are being cleared in the GLPaymentClearingSearchRequest.

totalAmountTo

number

false

none

Represents the total amount to be cleared in the payment transaction, facilitating accurate financial reconciliation.

fromPaymentDate

string(date)

false

none

Date of the from payment

toPaymentDate

string(date)

false

none

Date of the to payment

currencyId

integer(int64)

false

none

Unique identifier for the currency

postingDateFrom

string(date)

false

none

Specifies the starting date for filtering payment clearing records in the search request.

postingDateTo

string(date)

false

none

Specifies the end date for the posting period in the GL payment clearing search request, allowing users to filter results within a defined timeframe.

contractDisplayId

string

false

none

Unique identifier for the contract display

leaseDisplayId

string

false

none

Unique identifier for the lease display

tag

string

false

none

Identifier for categorizing and filtering payment clearing requests within the GLPaymentClearingSearchRequest schema.

ledgerEntryIds

[integer]

false

none

Array of unique identifiers for ledger entries associated with the GL payment clearing request.

ledgerEntryIdsNotIn

[integer]

false

none

Filter by excluding multiple values of ledger entry ids