General Ledger Payment Clearings¶
General Ledger Payment Clearings - Search¶
HTTP Request
POST /api/v1/general-ledger/payment-clearings/search
📋 Description: Submits a request to search for payment clearing records in the general ledger, enabling users to efficiently locate and analyze specific transactions based on defined criteria.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
true |
Request body containing the search criteria and filters for retrieving payment clearing records from the general ledger. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "ledgerTransactionId": 0,
21 "postingDate": "2019-08-24",
22 "ledgerEntryId": 0,
23 "entryType": "D",
24 "roundedAmount": 0,
25 "unroundedAmount": 0,
26 "deltaAdjustment": 0,
27 "tag": "string",
28 "company": {
29 "id": 0,
30 "displayId": "string"
31 },
32 "currency": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "decimalPoints": 0
38 },
39 "fiscalYear": 0,
40 "fiscalPeriod": 0,
41 "vendor": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemDisplayId": "string"
47 },
48 "paymentMethod": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "type": "string"
54 },
55 "paymentBlock": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string"
60 },
61 "paymentTerm": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string"
66 },
67 "taxRoundedAmount": 0,
68 "taxUnroundedAmount": 0,
69 "taxDeltaAdjustment": 0,
70 "ledgerEntryTaxes": [
71 {
72 "ledgerEntryId": 0,
73 "ledgerEntryTaxId": 0,
74 "conditionKey": "string",
75 "accountingKey": "string",
76 "taxAccount": "string",
77 "taxRoundedAmount": 0,
78 "taxUnroundedAmount": 0,
79 "taxBaseAmount": 0,
80 "deltaAdjustment": 0,
81 "totalTaxDocumentAmount": 0,
82 "taxExempt": 0,
83 "taxAffected": 0,
84 "taxExemptionPercentage": 0,
85 "taxRate": 0.1,
86 "taxJurisdiction": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "taxCode": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "taxDetermination": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "entryType": "D",
99 "ledgerEntryForAdditionalCurrencies": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "entryType": "D",
104 "amount": 0,
105 "unroundedAmount": 0,
106 "deltaAdjustment": 0,
107 "currency": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "currencyDefinitionType": "CONTRACT_CURRENCY",
112 "currencyType": "string",
113 "rate": 0,
114 "conversionDate": "2019-08-24",
115 "translationDateType": "DOCUMENT_DATE",
116 "sourceCurrencyType": "CONTRACT_CURRENCY",
117 "sourceCurrency": {
118 "id": 0,
119 "displayId": "string"
120 },
121 "depreciationArea": {
122 "id": 0,
123 "displayId": "string"
124 },
125 "ledgerEntryId": 0,
126 "ledgerEntryTaxId": 0,
127 "allowsSystemGenerateNewId": true,
128 "numberRangeIdentifierValue": "string",
129 "numberRangeIdentifierType": {
130 "name": "string"
131 },
132 "numberRangeType": {
133 "name": "string"
134 }
135 }
136 ]
137 }
138 ],
139 "contract": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "activeContractRevisionId": 0,
144 "lease": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "remainingAmount": 0,
149 "allocatedAmount": 0,
150 "matchedAmount": 0,
151 "postedAmount": 0,
152 "remainingTaxAmount": 0,
153 "state": "INV_DRAFT",
154 "approvalInfo": {
155 "approverUsername": "string",
156 "approvedAt": "2019-08-24T14:15:22Z"
157 },
158 "amountAllocations": [
159 {
160 "workspaceId": 0,
161 "workspaceDisplayId": "string",
162 "workspaceName": "string",
163 "vendorPaymentId": 0,
164 "amount": 0
165 }
166 ]
167 }
168 ],
169 "number": 0,
170 "sort": {
171 "unsorted": true,
172 "sorted": true,
173 "empty": true
174 },
175 "first": true,
176 "last": true,
177 "empty": true
178}
General Ledger Payment Clearings - Get Payment Clearing By Ledger Entry ID¶
HTTP Request
GET /api/v1/general-ledger/payment-clearings/ledger-entry/{ledgerEntryId}
📋 Description: Retrieves detailed information about a specific ledger entry identified by the provided ledgerEntryId, facilitating financial reconciliation and reporting processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
ledgerEntryId |
path |
integer(int64) |
true |
Unique identifier for the ledger entry |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "ledgerTransactionId": 0,
3 "postingDate": "2019-08-24",
4 "ledgerEntryId": 0,
5 "entryType": "D",
6 "roundedAmount": 0,
7 "unroundedAmount": 0,
8 "deltaAdjustment": 0,
9 "tag": "string",
10 "company": {
11 "id": 0,
12 "displayId": "string"
13 },
14 "currency": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "decimalPoints": 0
20 },
21 "fiscalYear": 0,
22 "fiscalPeriod": 0,
23 "vendor": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "paymentMethod": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "string"
36 },
37 "paymentBlock": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "paymentTerm": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string"
48 },
49 "taxRoundedAmount": 0,
50 "taxUnroundedAmount": 0,
51 "taxDeltaAdjustment": 0,
52 "ledgerEntryTaxes": [
53 {
54 "ledgerEntryId": 0,
55 "ledgerEntryTaxId": 0,
56 "conditionKey": "string",
57 "accountingKey": "string",
58 "taxAccount": "string",
59 "taxRoundedAmount": 0,
60 "taxUnroundedAmount": 0,
61 "taxBaseAmount": 0,
62 "deltaAdjustment": 0,
63 "totalTaxDocumentAmount": 0,
64 "taxExempt": 0,
65 "taxAffected": 0,
66 "taxExemptionPercentage": 0,
67 "taxRate": 0.1,
68 "taxJurisdiction": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "taxCode": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "taxDetermination": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "entryType": "D",
81 "ledgerEntryForAdditionalCurrencies": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "entryType": "D",
86 "amount": 0,
87 "unroundedAmount": 0,
88 "deltaAdjustment": 0,
89 "currency": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "currencyDefinitionType": "CONTRACT_CURRENCY",
94 "currencyType": "string",
95 "rate": 0,
96 "conversionDate": "2019-08-24",
97 "translationDateType": "DOCUMENT_DATE",
98 "sourceCurrencyType": "CONTRACT_CURRENCY",
99 "sourceCurrency": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "depreciationArea": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "ledgerEntryId": 0,
108 "ledgerEntryTaxId": 0,
109 "allowsSystemGenerateNewId": true,
110 "numberRangeIdentifierValue": "string",
111 "numberRangeIdentifierType": {
112 "name": "string"
113 },
114 "numberRangeType": {
115 "name": "string"
116 }
117 }
118 ]
119 }
120 ],
121 "contract": {
122 "id": 0,
123 "displayId": "string"
124 },
125 "activeContractRevisionId": 0,
126 "lease": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "remainingAmount": 0,
131 "allocatedAmount": 0,
132 "matchedAmount": 0,
133 "postedAmount": 0,
134 "remainingTaxAmount": 0,
135 "state": "INV_DRAFT",
136 "approvalInfo": {
137 "approverUsername": "string",
138 "approvedAt": "2019-08-24T14:15:22Z"
139 },
140 "amountAllocations": [
141 {
142 "workspaceId": 0,
143 "workspaceDisplayId": "string",
144 "workspaceName": "string",
145 "vendorPaymentId": 0,
146 "amount": 0
147 }
148 ]
149}