PageInvoiceDto¶
Example Json Object
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 "id": 0,
21 "displayId": "string",
22 "name": "string",
23 "invoiceType": "VENDOR_INV",
24 "state": "INV_DRAFT",
25 "externalDocumentNumber": "string",
26 "purchaseOrderReference": "string",
27 "invoiceDate": "2019-08-24",
28 "dueDate": "2019-08-24",
29 "notes": "string",
30 "billingPeriodFromDate": "2019-08-24",
31 "billingPeriodToDate": "2019-08-24",
32 "currency": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "decimalPoints": 0
38 },
39 "vendor": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "erpSystemDisplayId": "string"
45 },
46 "company": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "erpSystemId": 0,
51 "erpSystemDisplayId": "string",
52 "countryId": 0,
53 "countryDisplayId": "string",
54 "name": "string",
55 "postingPeriodVariantId": 0,
56 "fiscalVariantId": 0
57 },
58 "netAmount": 0,
59 "taxAmount": 0,
60 "totalAmount": 0,
61 "netAmountBalance": 0,
62 "taxAmountBalance": 0,
63 "paymentTerm": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string"
68 },
69 "paymentMethod": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "type": "string"
75 },
76 "paymentBlock": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string"
81 },
82 "defaultCostCenter": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0
88 },
89 "defaultProfitCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "validTo": "2019-08-24",
95 "erpSystemId": 0,
96 "erpSystemDisplayId": "string"
97 },
98 "invoiceLineItems": [
99 {
100 "id": 0,
101 "displayId": "string",
102 "expenseCategory": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "expenseCategoryType": "PAYMENT"
108 },
109 "description": "string",
110 "unitOfMeasure": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "erpSystemId": 0
116 },
117 "quantity": 0,
118 "unitPrice": 0,
119 "taxJurisdiction": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0,
125 "schema": "string",
126 "countryDisplayId": "string"
127 },
128 "taxCode": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0
134 },
135 "taxExpenseAccount": {
136 "id": 0,
137 "displayId": "string",
138 "generalLedgerAccountName": "string",
139 "generalLedgerAccountCode": "string",
140 "openItemManagement": true,
141 "accountCategory": "BALANCESHEET",
142 "shortName": "string",
143 "longName": "string"
144 },
145 "taxLineItems": [
146 {
147 "id": 0,
148 "taxRate": 0.1,
149 "taxAmount": 0,
150 "taxType": "string",
151 "invoiceLineItemId": 0
152 }
153 ],
154 "workBreakdownStructure": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "costCenter": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "profitCenter": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "validTo": "2019-08-24",
174 "erpSystemId": 0,
175 "erpSystemDisplayId": "string"
176 },
177 "functionalArea": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "erpSystemId": 0
183 },
184 "businessArea": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "segment": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "network": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "internalOrderType": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "internalOrder": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0,
218 "internalOrderTypeId": 0
219 },
220 "additionalCurrencies": [
221 {
222 "id": 0,
223 "amount": 0,
224 "currency": {
225 "id": 0,
226 "displayId": "string",
227 "status": "CREATED",
228 "name": "string",
229 "decimalPoints": 0
230 },
231 "conversionRate": 0,
232 "conversionDate": "2019-08-24",
233 "translationDateType": "DOCUMENT_DATE",
234 "amountType": "NET_AMOUNT",
235 "currencyDefinitionType": "CONTRACT_CURRENCY",
236 "invoiceEntryId": 0,
237 "invoiceEntryDisplayId": "string"
238 }
239 ],
240 "scheduledPaymentMatches": [
241 {
242 "id": 0,
243 "fromId": 0,
244 "toId": 0,
245 "amount": 0
246 }
247 ],
248 "goodsReceiptLineItemLinks": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "linkedQuantity": 0
254 }
255 ],
256 "invoiceId": 0,
257 "invoiceDisplayId": "string",
258 "invoiceState": "INV_DRAFT",
259 "vendorPaymentId": 0,
260 "purchaseOrderLineItemId": 0,
261 "netAmount": 0,
262 "allowsSystemGenerateNewId": true,
263 "numberRangeIdentifierValue": "string",
264 "numberRangeIdentifierType": {
265 "name": "string"
266 },
267 "numberRangeType": {
268 "name": "string"
269 }
270 }
271 ],
272 "workspaceId": 0,
273 "workspaceDisplayId": "string",
274 "workspaceName": "string",
275 "workspaceState": "INV_DRAFT",
276 "remainingNetAmount": 0,
277 "remainingTaxAmount": 0,
278 "remainingTotalAmount": 0,
279 "pendingPaymentCount": 0,
280 "allPaymentsPosted": true,
281 "approvalInfo": {
282 "approverUsername": "string",
283 "approvedAt": "2019-08-24T14:15:22Z"
284 },
285 "rejectionReason": "string",
286 "allowsSystemGenerateNewId": true,
287 "numberRangeIdentifierValue": "string",
288 "numberRangeIdentifierType": {
289 "name": "string"
290 },
291 "numberRangeType": {
292 "name": "string"
293 }
294 }
295 ],
296 "number": 0,
297 "sort": {
298 "unsorted": true,
299 "sorted": true,
300 "empty": true
301 },
302 "first": true,
303 "last": true,
304 "empty": true
305}
📄 Description: Data transfer object representing an invoice page, encapsulating essential billing information and associated metadata for streamlined financial transactions and reporting.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
totalPages |
integer(int32) |
false |
none |
Total number of pages available |
totalElements |
integer(int64) |
false |
none |
Total number of items available |
pageable |
false |
none |
Indicates whether the invoice data can be retrieved in a paginated format, facilitating efficient data management and retrieval. |
|
numberOfElements |
integer(int32) |
false |
none |
Indicates the total count of elements present in the invoice page, facilitating efficient pagination and data management. |
size |
integer(int32) |
false |
none |
Number of items per page |
content |
false |
none |
Array of PageInvoiceDto objects representing the detailed line items associated with the invoice, facilitating comprehensive billing and financial tracking. |
|
number |
integer(int32) |
false |
none |
Represents the invoice number associated with the page, serving as a key reference for tracking and managing billing transactions. |
sort |
false |
none |
Sort order specification |
|
first |
boolean |
false |
none |
Whether this is the first page |
last |
boolean |
false |
none |
Whether this is the last page |
empty |
boolean |
false |
none |
Whether the result set is empty |