Consolidated Transaction Report¶
Create¶
HTTP Request
POST /api/v1/general-ledger/consolidated-transaction-report
📋 Description: Generates a consolidated transaction report for ledger entries, providing a comprehensive overview of financial records across accounts within the General Ledger domain.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the consolidated transaction report data, including ledger entries, account details, and relevant financial records. |
Body Parameters
1{
2 "id": 0,
3 "queueTime": "2019-08-24T14:15:22Z",
4 "startTime": "2019-08-24T14:15:22Z",
5 "endTime": "2019-08-24T14:15:22Z",
6 "interruptedAt": "2019-08-24T14:15:22Z",
7 "recoveredAt": "2019-08-24T14:15:22Z",
8 "status": "CREATED",
9 "recover": true,
10 "interrupted": true,
11 "interruptionMessage": "string",
12 "errorMessage": "string",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 0,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "fileStorageId": "string",
20 "jsonFileStorageId": "string",
21 "generatingExportFile": true,
22 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
23 "version": 0,
24 "input": {
25 "ledgerTypeFilterType": "ALL",
26 "ledgerTypes": [
27 "LIABILITY"
28 ],
29 "transactionTypeValueFilterType": "ALL",
30 "transactionTypeValues": [
31 "string"
32 ],
33 "dateRangeType": "DOCUMENT_DATE",
34 "startDate": "2019-08-24",
35 "endDate": "2019-08-24",
36 "journalStateFilterType": "ALL",
37 "journalStates": [
38 "POST"
39 ],
40 "externalPostingStatusFilterType": "ALL",
41 "externalPostingStatuses": [
42 "NA"
43 ],
44 "businessAreaFilterType": "ALL",
45 "businessAreas": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemId": 0
52 }
53 ],
54 "functionalAreaFilterType": "ALL",
55 "functionalAreas": [
56 {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 }
63 ],
64 "migratedFilterType": "MIGRATED",
65 "partnerFilterType": "ALL",
66 "partners": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "erpSystemDisplayId": "string"
73 }
74 ],
75 "internalAssetClassFilterType": "ALL",
76 "internalAssetClasses": [
77 {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "assetClassType": "PROPERTY",
83 "infiniteUsefulLife": true
84 }
85 ],
86 "accountingStandardType": "GAAP",
87 "leaseClassificationFilterType": "ALL",
88 "classifications": [
89 "NON_LEASE"
90 ],
91 "referenceFieldType": "CONTRACT",
92 "referenceFieldDisplayIds": [
93 "string"
94 ]
95 },
96 "filter": {
97 "id": 0,
98 "name": "string",
99 "profileId": 0,
100 "calendarType": "REGULAR_CALENDAR",
101 "fiscalVariant": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "isCalendarYear": true,
106 "yearDependent": true,
107 "erpSystemDisplayId": "string",
108 "isErpSystemDefault": true
109 },
110 "principalPositionType": "LESSEE",
111 "erpSystemFilterType": "ALL",
112 "erpSystems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "type": "NAKISA",
119 "sapVersion": "ECC_EHP5"
120 }
121 ],
122 "leaseAreaFilterType": "ALL",
123 "leaseAreas": [
124 {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string"
129 }
130 ],
131 "businessUnitFilterType": "ALL",
132 "businessUnits": [
133 {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string"
138 }
139 ],
140 "companyFilterType": "ALL",
141 "companyCodes": [
142 {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "erpSystemId": 0,
147 "erpSystemDisplayId": "string",
148 "countryId": 0,
149 "countryDisplayId": "string",
150 "name": "string",
151 "postingPeriodVariantId": 0,
152 "fiscalVariantId": 0
153 }
154 ],
155 "departmentFilterType": "ALL",
156 "leaseDepartments": [
157 {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string"
162 }
163 ],
164 "leaseGroupFilterType": "ALL",
165 "leaseGroups": [
166 {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string"
171 }
172 ],
173 "costCenterFilterType": "ALL",
174 "costCenters": [
175 {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 }
182 ],
183 "profitCenterFilterType": "ALL",
184 "profitCenters": [
185 {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "validTo": "2019-08-24",
191 "erpSystemId": 0,
192 "erpSystemDisplayId": "string"
193 }
194 ],
195 "workBreakdownStructureFilterType": "ALL",
196 "workBreakdownStructures": [
197 {
198 "id": 0,
199 "displayId": "string",
200 "status": "CREATED",
201 "name": "string",
202 "erpSystemId": 0
203 }
204 ]
205 },
206 "docStoreId": 0,
207 "jsonDocStoreIds": [
208 0
209 ]
210}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "queueTime": "2019-08-24T14:15:22Z",
4 "startTime": "2019-08-24T14:15:22Z",
5 "endTime": "2019-08-24T14:15:22Z",
6 "interruptedAt": "2019-08-24T14:15:22Z",
7 "recoveredAt": "2019-08-24T14:15:22Z",
8 "status": "CREATED",
9 "recover": true,
10 "interrupted": true,
11 "interruptionMessage": "string",
12 "errorMessage": "string",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 0,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "fileStorageId": "string",
20 "jsonFileStorageId": "string",
21 "generatingExportFile": true,
22 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
23 "version": 0,
24 "input": {
25 "ledgerTypeFilterType": "ALL",
26 "ledgerTypes": [
27 "LIABILITY"
28 ],
29 "transactionTypeValueFilterType": "ALL",
30 "transactionTypeValues": [
31 "string"
32 ],
33 "dateRangeType": "DOCUMENT_DATE",
34 "startDate": "2019-08-24",
35 "endDate": "2019-08-24",
36 "journalStateFilterType": "ALL",
37 "journalStates": [
38 "POST"
39 ],
40 "externalPostingStatusFilterType": "ALL",
41 "externalPostingStatuses": [
42 "NA"
43 ],
44 "businessAreaFilterType": "ALL",
45 "businessAreas": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemId": 0
52 }
53 ],
54 "functionalAreaFilterType": "ALL",
55 "functionalAreas": [
56 {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 }
63 ],
64 "migratedFilterType": "MIGRATED",
65 "partnerFilterType": "ALL",
66 "partners": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "erpSystemDisplayId": "string"
73 }
74 ],
75 "internalAssetClassFilterType": "ALL",
76 "internalAssetClasses": [
77 {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "assetClassType": "PROPERTY",
83 "infiniteUsefulLife": true
84 }
85 ],
86 "accountingStandardType": "GAAP",
87 "leaseClassificationFilterType": "ALL",
88 "classifications": [
89 "NON_LEASE"
90 ],
91 "referenceFieldType": "CONTRACT",
92 "referenceFieldDisplayIds": [
93 "string"
94 ]
95 },
96 "filter": {
97 "id": 0,
98 "name": "string",
99 "profileId": 0,
100 "calendarType": "REGULAR_CALENDAR",
101 "fiscalVariant": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "isCalendarYear": true,
106 "yearDependent": true,
107 "erpSystemDisplayId": "string",
108 "isErpSystemDefault": true
109 },
110 "principalPositionType": "LESSEE",
111 "erpSystemFilterType": "ALL",
112 "erpSystems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "type": "NAKISA",
119 "sapVersion": "ECC_EHP5"
120 }
121 ],
122 "leaseAreaFilterType": "ALL",
123 "leaseAreas": [
124 {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string"
129 }
130 ],
131 "businessUnitFilterType": "ALL",
132 "businessUnits": [
133 {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string"
138 }
139 ],
140 "companyFilterType": "ALL",
141 "companyCodes": [
142 {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "erpSystemId": 0,
147 "erpSystemDisplayId": "string",
148 "countryId": 0,
149 "countryDisplayId": "string",
150 "name": "string",
151 "postingPeriodVariantId": 0,
152 "fiscalVariantId": 0
153 }
154 ],
155 "departmentFilterType": "ALL",
156 "leaseDepartments": [
157 {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string"
162 }
163 ],
164 "leaseGroupFilterType": "ALL",
165 "leaseGroups": [
166 {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string"
171 }
172 ],
173 "costCenterFilterType": "ALL",
174 "costCenters": [
175 {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 }
182 ],
183 "profitCenterFilterType": "ALL",
184 "profitCenters": [
185 {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "validTo": "2019-08-24",
191 "erpSystemId": 0,
192 "erpSystemDisplayId": "string"
193 }
194 ],
195 "workBreakdownStructureFilterType": "ALL",
196 "workBreakdownStructures": [
197 {
198 "id": 0,
199 "displayId": "string",
200 "status": "CREATED",
201 "name": "string",
202 "erpSystemId": 0
203 }
204 ]
205 },
206 "docStoreId": 0,
207 "jsonDocStoreIds": [
208 0
209 ]
210}
Search¶
HTTP Request
POST /api/v1/general-ledger/consolidated-transaction-report/search
📋 Description: Submits a request to generate a consolidated transaction report based on specified ledger entries and accounts, enabling users to analyze financial records efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
Request body containing the criteria for searching consolidated transaction reports, including ledger entries, transaction details, and associated account information. |
» filterDto |
body |
false |
Data transfer object representing the criteria for filtering consolidated transaction reports, encompassing ledger entries, transactions, accounts, and financial records within the General Ledger domain. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» queueTimeGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where queue time is greater than or equal to specified value |
»» queueTimeLessThanOrEqual |
body |
string(date-time) |
false |
Filter where queue time is less than or equal to specified value |
»» startTimeGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where start time is greater than or equal to specified value |
»» startTimeLessThanOrEqual |
body |
string(date-time) |
false |
Filter where start time is less than or equal to specified value |
»» endTimeGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where end time is greater than or equal to specified value |
»» endTimeLessThanOrEqual |
body |
string(date-time) |
false |
Filter where end time is less than or equal to specified value |
»» statusIn |
body |
[string] |
false |
Filter by multiple values of status |
»» statusEqual |
body |
string |
false |
Filter by exact match of status |
»» executorEqual |
body |
string |
false |
Filter by exact match of executor |
»» uiSelector |
body |
string |
false |
Text value for uiSelector in ConsolidatedTransactionReportExtendedJobInputDtoFilter |
»» dateRangeTypeEqual |
body |
string |
false |
Filter by exact match of date range type |
»» ledgerTypesIn |
body |
[string] |
false |
Filter by multiple values of ledger types |
»» transactionTypeValuesIn |
body |
[string] |
false |
Filter by multiple values of transaction type values |
»» startDateGreaterThanOrEqual |
body |
string(date) |
false |
Filter where start date is greater than or equal to specified value |
»» startDateLessThanOrEqual |
body |
string(date) |
false |
Filter where start date is less than or equal to specified value |
»» endDateGreaterThanOrEqual |
body |
string(date) |
false |
Filter where end date is greater than or equal to specified value |
»» endDateLessThanOrEqual |
body |
string(date) |
false |
Filter where end date is less than or equal to specified value |
»» accountingStandardTypeEqual |
body |
string |
false |
Filter by exact match of accounting standard type |
»» externalPostingStatusesIn |
body |
[string] |
false |
Filter by multiple values of external posting statuses |
»» functionalAreasIn |
body |
false |
[Data transfer object representing a simplified view of a functional area within the General Ledger, encompassing key attributes related to ledger entries, transactions, accounts, and financial records.] |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
string |
false |
Status of the resource |
»»» name |
body |
string |
false |
Name of the resource |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» businessAreasIn |
body |
false |
[Data transfer object representing a simplified view of a business area within the General Ledger, encompassing key attributes related to ledger entries, transactions, accounts, and financial records.] |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
string |
false |
Status of the resource |
»»» name |
body |
string |
false |
Name of the resource |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
» pageable |
body |
false |
Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» accountingStandardTypeEqual |
GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET |
»» dateRangeTypeEqual |
DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE, USER_DOCUMENT_DATE |
»» executorEqual |
MANUAL, SCHEDULER |
»» externalPostingStatusesIn |
, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED |
»» ledgerTypesIn |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
»» statusEqual |
CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED |
»» statusIn |
CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED |
»»» status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filterDto": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "queueTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
17 "queueTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
18 "startTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
19 "startTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
20 "endTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
21 "endTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
22 "statusIn": [
23 "CREATED"
24 ],
25 "statusEqual": "CREATED",
26 "executorEqual": "SCHEDULER",
27 "uiSelector": "string",
28 "dateRangeTypeEqual": "DOCUMENT_DATE",
29 "ledgerTypesIn": [
30 "LIABILITY"
31 ],
32 "transactionTypeValuesIn": [
33 "string"
34 ],
35 "startDateGreaterThanOrEqual": "2019-08-24",
36 "startDateLessThanOrEqual": "2019-08-24",
37 "endDateGreaterThanOrEqual": "2019-08-24",
38 "endDateLessThanOrEqual": "2019-08-24",
39 "accountingStandardTypeEqual": "GAAP",
40 "externalPostingStatusesIn": [
41 "NA"
42 ],
43 "functionalAreasIn": [
44 {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0
50 }
51 ],
52 "businessAreasIn": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "erpSystemId": 0
59 }
60 ]
61 },
62 "pageable": {
63 "page": 0,
64 "size": 1,
65 "sort": [
66 "string"
67 ]
68 }
69}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "id": 0,
21 "queueTime": "2019-08-24T14:15:22Z",
22 "startTime": "2019-08-24T14:15:22Z",
23 "endTime": "2019-08-24T14:15:22Z",
24 "interruptedAt": "2019-08-24T14:15:22Z",
25 "recoveredAt": "2019-08-24T14:15:22Z",
26 "status": "CREATED",
27 "recover": true,
28 "interrupted": true,
29 "interruptionMessage": "string",
30 "errorMessage": "string",
31 "executor": "SCHEDULER",
32 "scheduleJobId": 0,
33 "batchSize": 0,
34 "totalObjectCount": 0,
35 "readOnly": true,
36 "profileId": 0,
37 "fileStorageId": "string",
38 "jsonFileStorageId": "string",
39 "generatingExportFile": true,
40 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
41 "version": 0,
42 "input": {
43 "ledgerTypeFilterType": "ALL",
44 "ledgerTypes": [
45 "LIABILITY"
46 ],
47 "transactionTypeValueFilterType": "ALL",
48 "transactionTypeValues": [
49 "string"
50 ],
51 "dateRangeType": "DOCUMENT_DATE",
52 "startDate": "2019-08-24",
53 "endDate": "2019-08-24",
54 "journalStateFilterType": "ALL",
55 "journalStates": [
56 "POST"
57 ],
58 "externalPostingStatusFilterType": "ALL",
59 "externalPostingStatuses": [
60 "NA"
61 ],
62 "businessAreaFilterType": "ALL",
63 "businessAreas": [
64 {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 }
71 ],
72 "functionalAreaFilterType": "ALL",
73 "functionalAreas": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 }
81 ],
82 "migratedFilterType": "MIGRATED",
83 "partnerFilterType": "ALL",
84 "partners": [
85 {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemDisplayId": "string"
91 }
92 ],
93 "internalAssetClassFilterType": "ALL",
94 "internalAssetClasses": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "status": "CREATED",
99 "name": "string",
100 "assetClassType": "PROPERTY",
101 "infiniteUsefulLife": true
102 }
103 ],
104 "accountingStandardType": "GAAP",
105 "leaseClassificationFilterType": "ALL",
106 "classifications": [
107 "NON_LEASE"
108 ],
109 "referenceFieldType": "CONTRACT",
110 "referenceFieldDisplayIds": [
111 "string"
112 ]
113 },
114 "filter": {
115 "id": 0,
116 "name": "string",
117 "profileId": 0,
118 "calendarType": "REGULAR_CALENDAR",
119 "fiscalVariant": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "isCalendarYear": true,
124 "yearDependent": true,
125 "erpSystemDisplayId": "string",
126 "isErpSystemDefault": true
127 },
128 "principalPositionType": "LESSEE",
129 "erpSystemFilterType": "ALL",
130 "erpSystems": [
131 {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "type": "NAKISA",
137 "sapVersion": "ECC_EHP5"
138 }
139 ],
140 "leaseAreaFilterType": "ALL",
141 "leaseAreas": [
142 {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string"
147 }
148 ],
149 "businessUnitFilterType": "ALL",
150 "businessUnits": [
151 {
152 "id": 0,
153 "displayId": "string",
154 "status": "CREATED",
155 "name": "string"
156 }
157 ],
158 "companyFilterType": "ALL",
159 "companyCodes": [
160 {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "erpSystemId": 0,
165 "erpSystemDisplayId": "string",
166 "countryId": 0,
167 "countryDisplayId": "string",
168 "name": "string",
169 "postingPeriodVariantId": 0,
170 "fiscalVariantId": 0
171 }
172 ],
173 "departmentFilterType": "ALL",
174 "leaseDepartments": [
175 {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string"
180 }
181 ],
182 "leaseGroupFilterType": "ALL",
183 "leaseGroups": [
184 {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string"
189 }
190 ],
191 "costCenterFilterType": "ALL",
192 "costCenters": [
193 {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 }
200 ],
201 "profitCenterFilterType": "ALL",
202 "profitCenters": [
203 {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 }
212 ],
213 "workBreakdownStructureFilterType": "ALL",
214 "workBreakdownStructures": [
215 {
216 "id": 0,
217 "displayId": "string",
218 "status": "CREATED",
219 "name": "string",
220 "erpSystemId": 0
221 }
222 ]
223 },
224 "docStoreId": 0,
225 "jsonDocStoreIds": [
226 0
227 ]
228 }
229 ],
230 "number": 0,
231 "sort": {
232 "unsorted": true,
233 "sorted": true,
234 "empty": true
235 },
236 "first": true,
237 "last": true,
238 "empty": true
239}
Validate Reference Field IDs¶
HTTP Request
POST /api/v1/general-ledger/consolidated-transaction-report/reference-field/validate
📋 Description: Validates reference fields for consolidated transaction reports within the General Ledger, ensuring accuracy and compliance of ledger entries, transactions, and financial records associated with specific accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the reference field data necessary for validating ledger entries and transactions within the consolidated transaction report. |
» transactionReportJobDto |
body |
false |
Data transfer object representing a consolidated transaction report job, encapsulating details related to ledger entries, transactions, accounts, and financial records for streamlined reporting and analysis within the General Ledger domain. |
|
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» queueTime |
body |
string(date-time) |
false |
Time of the queue |
»» startTime |
body |
string(date-time) |
false |
Time of the start |
»» endTime |
body |
string(date-time) |
false |
Time of the end |
»» interruptedAt |
body |
string(date-time) |
false |
Text value for interruptedAt in ConsolidatedTransactionReportJobDto |
»» recoveredAt |
body |
string(date-time) |
false |
Text value for recoveredAt in ConsolidatedTransactionReportJobDto |
»» status |
body |
string |
false |
Status of the resource |
»» recover |
body |
boolean |
false |
Boolean flag indicating recover status |
»» interrupted |
body |
boolean |
false |
Boolean flag indicating interrupted status |
»» interruptionMessage |
body |
string |
false |
Text value for interruptionMessage in ConsolidatedTransactionReportJobDto |
»» errorMessage |
body |
string |
false |
Text value for errorMessage in ConsolidatedTransactionReportJobDto |
»» executor |
body |
string |
false |
Text value for executor in ConsolidatedTransactionReportJobDto |
»» scheduleJobId |
body |
integer(int64) |
false |
Unique identifier for the schedule job |
»» batchSize |
body |
integer(int32) |
false |
Numeric value representing batchSize |
»» totalObjectCount |
body |
integer(int32) |
false |
Count of total object |
»» readOnly |
body |
boolean |
false |
Boolean flag indicating readOnly status |
»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»» fileStorageId |
body |
string |
false |
Unique identifier for the file storage |
»» jsonFileStorageId |
body |
string |
false |
Unique identifier for the json file storage |
»» generatingExportFile |
body |
boolean |
false |
Boolean flag indicating generatingExportFile status |
»» startedGeneratingExportFileAt |
body |
string(date-time) |
false |
Text value for startedGeneratingExportFileAt in ConsolidatedTransactionReportJobDto |
»» version |
body |
integer(int32) |
false |
Numeric value representing version |
»» input |
body |
false |
Data transfer object representing the input parameters for generating a consolidated transaction report within the General Ledger, encompassing ledger entries, transactions, accounts, and associated financial records. |
|
»»» ledgerTypeFilterType |
body |
string |
true |
Type of the ledger type filter |
»»» ledgerTypes |
body |
[string] |
false |
List of ledgerTypes items |
»»» transactionTypeValueFilterType |
body |
string |
true |
Type of the transaction type value filter |
»»» transactionTypeValues |
body |
[string] |
false |
List of transactionTypeValues items |
»»» dateRangeType |
body |
string |
true |
Type of the date range |
»»» startDate |
body |
string(date) |
false |
Start date of the resource |
»»» endDate |
body |
string(date) |
false |
End date of the resource |
»»» journalStateFilterType |
body |
string |
true |
Type of the journal state filter |
»»» journalStates |
body |
[string] |
false |
List of journalStates items |
»»» externalPostingStatusFilterType |
body |
string |
true |
Type of the external posting status filter |
»»» externalPostingStatuses |
body |
[string] |
false |
List of externalPostingStatuses items |
»»» businessAreaFilterType |
body |
string |
true |
none |
»»» businessAreas |
body |
false |
List of businessAreas items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» erpSystemId |
body |
integer(int64) |
false |
none |
»»» functionalAreaFilterType |
body |
string |
true |
none |
»»» functionalAreas |
body |
false |
List of functionalAreas items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» erpSystemId |
body |
integer(int64) |
false |
none |
»»» migratedFilterType |
body |
string |
true |
Type of the migrated filter |
»»» partnerFilterType |
body |
string |
true |
none |
»»» partners |
body |
false |
[Data transfer object representing a simplified partner record within the General Ledger, encompassing essential details related to ledger entries, transactions, accounts, and financial records.] |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» erpSystemDisplayId |
body |
string |
false |
Unique identifier for the erp system display |
»»» internalAssetClassFilterType |
body |
string |
true |
Type of the internal asset class filter |
»»» internalAssetClasses |
body |
false |
List of internalAssetClasses items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» assetClassType |
body |
string |
false |
Type of the asset class |
»»»» infiniteUsefulLife |
body |
boolean |
false |
Boolean flag indicating infiniteUsefulLife status |
»»» accountingStandardType |
body |
string |
true |
Type of the accounting standard |
»»» leaseClassificationFilterType |
body |
string |
true |
Type of the lease classification filter |
»»» classifications |
body |
[string] |
false |
List of classifications items |
»»» referenceFieldType |
body |
string |
false |
Type of the reference field |
»»» referenceFieldDisplayIds |
body |
[string] |
false |
List of referenceFieldDisplayIds items |
»» filter |
body |
false |
Data transfer object representing the filters applied to generate a consolidated transaction report in the General Ledger, encompassing ledger entries, transactions, accounts, and financial records. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» name |
body |
string |
false |
Name of the resource |
»»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»»» calendarType |
body |
string |
true |
Type of the calendar |
»»» fiscalVariant |
body |
false |
Data transfer object representing a simplified fiscal variant used in general ledger entries, encapsulating essential details related to transactions, accounts, and financial records. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» isCalendarYear |
body |
boolean |
false |
Whether the resource is calendar year |
»»»» yearDependent |
body |
boolean |
false |
Boolean flag indicating yearDependent status |
»»»» erpSystemDisplayId |
body |
string |
false |
Unique identifier for the erp system display |
»»»» isErpSystemDefault |
body |
boolean |
false |
Whether the resource is erp system default |
»»» principalPositionType |
body |
string |
true |
Type of the principal position |
»»» erpSystemFilterType |
body |
string |
true |
Type of the erp system filter |
»»» erpSystems |
body |
false |
List of erpSystems items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» type |
body |
string |
false |
Type of the resource |
»»»» sapVersion |
body |
string |
false |
Text value for sapVersion in ErpSystemLite |
»»» leaseAreaFilterType |
body |
string |
true |
Type of the lease area filter |
»»» leaseAreas |
body |
false |
List of leaseAreas items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»» businessUnitFilterType |
body |
string |
true |
Type of the business unit filter |
»»» businessUnits |
body |
false |
List of businessUnits items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»» companyFilterType |
body |
string |
true |
Type of the company filter |
»»» companyCodes |
body |
false |
List of companyCodes items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» erpSystemId |
body |
integer(int64) |
false |
Unique identifier for the erp system |
»»»» erpSystemDisplayId |
body |
string |
false |
Unique identifier for the erp system display |
»»»» countryId |
body |
integer(int64) |
false |
Unique identifier for the country |
»»»» countryDisplayId |
body |
string |
false |
Unique identifier for the country display |
»»»» name |
body |
string |
false |
none |
»»»» postingPeriodVariantId |
body |
integer(int64) |
false |
Unique identifier for the posting period variant |
»»»» fiscalVariantId |
body |
integer(int64) |
false |
Unique identifier for the fiscal variant |
»»» departmentFilterType |
body |
string |
true |
Type of the department filter |
»»» leaseDepartments |
body |
false |
List of leaseDepartments items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»» leaseGroupFilterType |
body |
string |
true |
Type of the lease group filter |
»»» leaseGroups |
body |
false |
List of leaseGroups items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»» costCenterFilterType |
body |
string |
true |
Type of the cost center filter |
»»» costCenters |
body |
false |
List of costCenters items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» erpSystemId |
body |
integer(int64) |
false |
none |
»»» profitCenterFilterType |
body |
string |
true |
Type of the profit center filter |
»»» profitCenters |
body |
false |
List of profitCenters items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» validTo |
body |
string(date) |
false |
Date until which the resource is valid |
»»»» erpSystemId |
body |
integer(int64) |
false |
Unique identifier for the erp system |
»»»» erpSystemDisplayId |
body |
string |
false |
Unique identifier for the erp system display |
»»» workBreakdownStructureFilterType |
body |
string |
true |
Type of the work breakdown structure filter |
»»» workBreakdownStructures |
body |
false |
List of workBreakdownStructures items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» status |
body |
string |
false |
Status of the resource |
»»»» name |
body |
string |
false |
Name of the resource |
»»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» docStoreId |
body |
integer(int64) |
false |
Unique identifier for the doc store |
»» jsonDocStoreIds |
body |
[integer] |
false |
List of jsonDocStoreIds items |
» pageable |
body |
false |
Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» executor |
MANUAL, SCHEDULER |
»» status |
CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED |
»»» accountingStandardType |
GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET |
»»» businessAreaFilterType |
ALL, LIST |
»»» businessUnitFilterType |
ALL, LIST |
»»» calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
»»» classifications |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
»»» companyFilterType |
ALL, LIST |
»»» costCenterFilterType |
ALL, LIST |
»»» dateRangeType |
DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE, USER_DOCUMENT_DATE |
»»» departmentFilterType |
ALL, LIST |
»»» erpSystemFilterType |
ALL, LIST |
»»» externalPostingStatusFilterType |
ALL, LIST |
»»» externalPostingStatuses |
, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED |
»»» functionalAreaFilterType |
ALL, LIST |
»»» internalAssetClassFilterType |
ALL, LIST |
»»» journalStateFilterType |
ALL, LIST |
»»» journalStates |
POST, REVERSE |
»»» leaseAreaFilterType |
ALL, LIST |
»»» leaseClassificationFilterType |
ALL, LIST |
»»» leaseGroupFilterType |
ALL, LIST |
»»» ledgerTypeFilterType |
ALL, LIST |
»»» ledgerTypes |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
»»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» partnerFilterType |
ALL, LIST |
»»» principalPositionType |
LESSEE, LESSOR |
»»» profitCenterFilterType |
ALL, LIST |
»»» referenceFieldType |
ACTIVATION_GROUP, CONTRACT, CONTRACT_EXTERNAL_ID, INVOICE, INVOICE_VENDOR, JOURNAL_ID, LEASE, LEASE_COMPONENT, LOCATION, PREMISE, UNIT |
»»» transactionTypeValueFilterType |
ALL, LIST |
»»» workBreakdownStructureFilterType |
ALL, LIST |
»»»» assetClassType |
EQUIPMENT, PLANT, PROPERTY |
»»»» sapVersion |
ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909 |
»»»» status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»» type |
NAKISA, SAP |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "transactionReportJobDto": {
3 "id": 0,
4 "queueTime": "2019-08-24T14:15:22Z",
5 "startTime": "2019-08-24T14:15:22Z",
6 "endTime": "2019-08-24T14:15:22Z",
7 "interruptedAt": "2019-08-24T14:15:22Z",
8 "recoveredAt": "2019-08-24T14:15:22Z",
9 "status": "CREATED",
10 "recover": true,
11 "interrupted": true,
12 "interruptionMessage": "string",
13 "errorMessage": "string",
14 "executor": "SCHEDULER",
15 "scheduleJobId": 0,
16 "batchSize": 0,
17 "totalObjectCount": 0,
18 "readOnly": true,
19 "profileId": 0,
20 "fileStorageId": "string",
21 "jsonFileStorageId": "string",
22 "generatingExportFile": true,
23 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
24 "version": 0,
25 "input": {
26 "ledgerTypeFilterType": "ALL",
27 "ledgerTypes": [
28 "LIABILITY"
29 ],
30 "transactionTypeValueFilterType": "ALL",
31 "transactionTypeValues": [
32 "string"
33 ],
34 "dateRangeType": "DOCUMENT_DATE",
35 "startDate": "2019-08-24",
36 "endDate": "2019-08-24",
37 "journalStateFilterType": "ALL",
38 "journalStates": [
39 "POST"
40 ],
41 "externalPostingStatusFilterType": "ALL",
42 "externalPostingStatuses": [
43 "NA"
44 ],
45 "businessAreaFilterType": "ALL",
46 "businessAreas": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "name": "string",
52 "erpSystemId": 0
53 }
54 ],
55 "functionalAreaFilterType": "ALL",
56 "functionalAreas": [
57 {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 }
64 ],
65 "migratedFilterType": "MIGRATED",
66 "partnerFilterType": "ALL",
67 "partners": [
68 {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemDisplayId": "string"
74 }
75 ],
76 "internalAssetClassFilterType": "ALL",
77 "internalAssetClasses": [
78 {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "assetClassType": "PROPERTY",
84 "infiniteUsefulLife": true
85 }
86 ],
87 "accountingStandardType": "GAAP",
88 "leaseClassificationFilterType": "ALL",
89 "classifications": [
90 "NON_LEASE"
91 ],
92 "referenceFieldType": "CONTRACT",
93 "referenceFieldDisplayIds": [
94 "string"
95 ]
96 },
97 "filter": {
98 "id": 0,
99 "name": "string",
100 "profileId": 0,
101 "calendarType": "REGULAR_CALENDAR",
102 "fiscalVariant": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "isCalendarYear": true,
107 "yearDependent": true,
108 "erpSystemDisplayId": "string",
109 "isErpSystemDefault": true
110 },
111 "principalPositionType": "LESSEE",
112 "erpSystemFilterType": "ALL",
113 "erpSystems": [
114 {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "type": "NAKISA",
120 "sapVersion": "ECC_EHP5"
121 }
122 ],
123 "leaseAreaFilterType": "ALL",
124 "leaseAreas": [
125 {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string"
130 }
131 ],
132 "businessUnitFilterType": "ALL",
133 "businessUnits": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string"
139 }
140 ],
141 "companyFilterType": "ALL",
142 "companyCodes": [
143 {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "erpSystemId": 0,
148 "erpSystemDisplayId": "string",
149 "countryId": 0,
150 "countryDisplayId": "string",
151 "name": "string",
152 "postingPeriodVariantId": 0,
153 "fiscalVariantId": 0
154 }
155 ],
156 "departmentFilterType": "ALL",
157 "leaseDepartments": [
158 {
159 "id": 0,
160 "displayId": "string",
161 "status": "CREATED",
162 "name": "string"
163 }
164 ],
165 "leaseGroupFilterType": "ALL",
166 "leaseGroups": [
167 {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string"
172 }
173 ],
174 "costCenterFilterType": "ALL",
175 "costCenters": [
176 {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 }
183 ],
184 "profitCenterFilterType": "ALL",
185 "profitCenters": [
186 {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "validTo": "2019-08-24",
192 "erpSystemId": 0,
193 "erpSystemDisplayId": "string"
194 }
195 ],
196 "workBreakdownStructureFilterType": "ALL",
197 "workBreakdownStructures": [
198 {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 }
205 ]
206 },
207 "docStoreId": 0,
208 "jsonDocStoreIds": [
209 0
210 ]
211 },
212 "pageable": {
213 "page": 0,
214 "size": 1,
215 "sort": [
216 "string"
217 ]
218 }
219}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "string"
20 ],
21 "number": 0,
22 "sort": {
23 "unsorted": true,
24 "sorted": true,
25 "empty": true
26 },
27 "first": true,
28 "last": true,
29 "empty": true
30}
Cancel¶
HTTP Request
POST /api/v1/general-ledger/consolidated-transaction-report/cancel/{id}
📋 Description: Cancels a specified consolidated transaction report in the General Ledger, effectively removing the associated ledger entry from financial records and ensuring accurate account management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Generate Report To Standard Excel¶
HTTP Request
GET /api/v1/general-ledger/consolidated-transaction-report/generate_standard_report/{id}
📋 Description: Generates a standard consolidated transaction report for a specified ledger entry, providing a comprehensive overview of financial records associated with the given account. This operation allows users to access detailed transaction data for informed financial analysis and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Generate Report To Excel¶
HTTP Request
GET /api/v1/general-ledger/consolidated-transaction-report/generate_report/{id}
📋 Description: Generates a consolidated transaction report for a specified ledger entry, providing a comprehensive overview of financial records associated with the given account. This operation facilitates informed decision-making by delivering essential transaction data in a structured format.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Download Report To Excel¶
HTTP Request
GET /api/v1/general-ledger/consolidated-transaction-report/download_report/{id}
📋 Description: Downloads the consolidated transaction report for a specified ledger entry, providing a comprehensive overview of financial records associated with the given account. This operation facilitates efficient access to critical transaction data for financial analysis and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete By ID¶
HTTP Request
DELETE /api/v1/general-ledger/consolidated-transaction-report/{id}
📋 Description: Deletes a specified consolidated transaction report from the general ledger, ensuring that the associated financial records and ledger entries are accurately maintained.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |