Purchase Requisition Line Item¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/purchase-requisition-item/{id}
📋 Description: Returns the single resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "quantity": 0,
18 "allocatedQuantity": 0,
19 "unitPrice": 0,
20 "description": "string",
21 "expenseCategory": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "expenseCategoryType": "PAYMENT"
27 },
28 "costCenter": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "validTo": "2019-08-24",
41 "erpSystemId": 0,
42 "erpSystemDisplayId": "string"
43 },
44 "purchaseRequisitionId": 0,
45 "purchaseRequisitionDisplayId": "string",
46 "purchaseOrderLineItems": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "quantity": 0,
51 "allocatedQuantity": 0,
52 "receivedQuantity": 0,
53 "unitPrice": 0,
54 "description": "string",
55 "expenseCategory": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "expenseCategoryType": "PAYMENT"
61 },
62 "costCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "erpSystemId": 0
68 },
69 "profitCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "validTo": "2019-08-24",
75 "erpSystemId": 0,
76 "erpSystemDisplayId": "string"
77 },
78 "taxJurisdiction": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0,
84 "schema": "string",
85 "countryDisplayId": "string"
86 },
87 "taxCode": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "taxLineItems": [
95 {
96 "id": 0,
97 "taxRate": 0.1,
98 "taxAmount": 0,
99 "taxType": "string",
100 "purchaseOrderLineItemId": 0
101 }
102 ],
103 "purchaseOrderId": 0,
104 "purchaseOrderDisplayId": "string",
105 "purchaseOrderState": "INV_DRAFT",
106 "invoiceLineItems": [
107 {
108 "id": 0,
109 "displayId": "string",
110 "expenseCategory": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "expenseCategoryType": "PAYMENT"
116 },
117 "description": "string",
118 "unitOfMeasure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "quantity": 0,
126 "unitPrice": 0,
127 "taxJurisdiction": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "schema": "string",
134 "countryDisplayId": "string"
135 },
136 "taxCode": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "taxExpenseAccount": {
144 "id": 0,
145 "displayId": "string",
146 "generalLedgerAccountName": "string",
147 "generalLedgerAccountCode": "string",
148 "openItemManagement": true,
149 "accountCategory": "BALANCESHEET",
150 "shortName": "string",
151 "longName": "string"
152 },
153 "taxLineItems": [
154 {
155 "id": 0,
156 "taxRate": 0.1,
157 "taxAmount": 0,
158 "taxType": "string",
159 "invoiceLineItemId": 0
160 }
161 ],
162 "workBreakdownStructure": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "costCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "profitCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "validTo": "2019-08-24",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string"
184 },
185 "functionalArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "businessArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "segment": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "network": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrderType": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrder": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0,
226 "internalOrderTypeId": 0
227 },
228 "additionalCurrencies": [
229 {
230 "id": 0,
231 "amount": 0,
232 "currency": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "decimalPoints": 0
238 },
239 "conversionRate": 0,
240 "conversionDate": "2019-08-24",
241 "translationDateType": "DOCUMENT_DATE",
242 "amountType": "NET_AMOUNT",
243 "currencyDefinitionType": "CONTRACT_CURRENCY",
244 "invoiceEntryId": 0,
245 "invoiceEntryDisplayId": "string"
246 }
247 ],
248 "scheduledPaymentMatches": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "amount": 0
254 }
255 ],
256 "goodsReceiptLineItemLinks": [
257 {
258 "id": 0,
259 "fromId": 0,
260 "toId": 0,
261 "linkedQuantity": 0
262 }
263 ],
264 "invoiceId": 0,
265 "invoiceDisplayId": "string",
266 "invoiceState": "INV_DRAFT",
267 "vendorPaymentId": 0,
268 "purchaseOrderLineItemId": 0,
269 "netAmount": 0,
270 "allowsSystemGenerateNewId": true,
271 "numberRangeIdentifierValue": "string",
272 "numberRangeIdentifierType": {
273 "name": "string"
274 },
275 "numberRangeType": {
276 "name": "string"
277 }
278 }
279 ],
280 "goodsReceiptLineItems": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "quantity": 0,
285 "invoicedQuantity": 0,
286 "description": "string",
287 "expenseCategory": {
288 "id": 0,
289 "displayId": "string",
290 "status": "CREATED",
291 "name": "string",
292 "expenseCategoryType": "PAYMENT"
293 },
294 "goodsReceiptId": 0,
295 "goodsReceiptDisplayId": "string",
296 "goodsReceiptState": "INV_DRAFT",
297 "purchaseOrderLineItemId": 0,
298 "invoiceLineItemLinks": [
299 {
300 "id": 0,
301 "fromId": 0,
302 "toId": 0,
303 "linkedQuantity": 0
304 }
305 ],
306 "availableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "vendorPaymentId": 0,
318 "purchaseRequisitionLineItemId": 0,
319 "purchaseRequisitionDisplayId": "string",
320 "purchaseRequisitionLineItemAvailableQuantity": 0,
321 "remainingQuantity": 0,
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343}
Update A Resource¶
HTTP Request
PUT /api/v1/purchase-requisition-item/{id}
📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
body |
body |
true |
Request body containing the updated details of the purchase requisition item, including quantity, pricing, and any relevant notes for approval. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "unitPrice": 0,
7 "description": "string",
8 "expenseCategory": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "expenseCategoryType": "PAYMENT"
14 },
15 "costCenter": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "erpSystemId": 0
21 },
22 "profitCenter": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "validTo": "2019-08-24",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string"
30 },
31 "purchaseRequisitionId": 0,
32 "purchaseRequisitionDisplayId": "string",
33 "purchaseOrderLineItems": [
34 {
35 "id": 0,
36 "displayId": "string",
37 "quantity": 0,
38 "allocatedQuantity": 0,
39 "receivedQuantity": 0,
40 "unitPrice": 0,
41 "description": "string",
42 "expenseCategory": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "expenseCategoryType": "PAYMENT"
48 },
49 "costCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "erpSystemId": 0
55 },
56 "profitCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "validTo": "2019-08-24",
62 "erpSystemId": 0,
63 "erpSystemDisplayId": "string"
64 },
65 "taxJurisdiction": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "schema": "string",
72 "countryDisplayId": "string"
73 },
74 "taxCode": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "taxLineItems": [
82 {
83 "id": 0,
84 "taxRate": 0.1,
85 "taxAmount": 0,
86 "taxType": "string",
87 "purchaseOrderLineItemId": 0
88 }
89 ],
90 "purchaseOrderId": 0,
91 "purchaseOrderDisplayId": "string",
92 "purchaseOrderState": "INV_DRAFT",
93 "invoiceLineItems": [
94 {
95 "id": 0,
96 "displayId": "string",
97 "expenseCategory": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "expenseCategoryType": "PAYMENT"
103 },
104 "description": "string",
105 "unitOfMeasure": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0
111 },
112 "quantity": 0,
113 "unitPrice": 0,
114 "taxJurisdiction": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "schema": "string",
121 "countryDisplayId": "string"
122 },
123 "taxCode": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "taxExpenseAccount": {
131 "id": 0,
132 "displayId": "string",
133 "generalLedgerAccountName": "string",
134 "generalLedgerAccountCode": "string",
135 "openItemManagement": true,
136 "accountCategory": "BALANCESHEET",
137 "shortName": "string",
138 "longName": "string"
139 },
140 "taxLineItems": [
141 {
142 "id": 0,
143 "taxRate": 0.1,
144 "taxAmount": 0,
145 "taxType": "string",
146 "invoiceLineItemId": 0
147 }
148 ],
149 "workBreakdownStructure": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string",
154 "erpSystemId": 0
155 },
156 "costCenter": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "profitCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "validTo": "2019-08-24",
169 "erpSystemId": 0,
170 "erpSystemDisplayId": "string"
171 },
172 "functionalArea": {
173 "id": 0,
174 "displayId": "string",
175 "status": "CREATED",
176 "name": "string",
177 "erpSystemId": 0
178 },
179 "businessArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "segment": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "network": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "internalOrderType": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrder": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0,
213 "internalOrderTypeId": 0
214 },
215 "additionalCurrencies": [
216 {
217 "id": 0,
218 "amount": 0,
219 "currency": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "decimalPoints": 0
225 },
226 "conversionRate": 0,
227 "conversionDate": "2019-08-24",
228 "translationDateType": "DOCUMENT_DATE",
229 "amountType": "NET_AMOUNT",
230 "currencyDefinitionType": "CONTRACT_CURRENCY",
231 "invoiceEntryId": 0,
232 "invoiceEntryDisplayId": "string"
233 }
234 ],
235 "scheduledPaymentMatches": [
236 {
237 "id": 0,
238 "fromId": 0,
239 "toId": 0,
240 "amount": 0
241 }
242 ],
243 "goodsReceiptLineItemLinks": [
244 {
245 "id": 0,
246 "fromId": 0,
247 "toId": 0,
248 "linkedQuantity": 0
249 }
250 ],
251 "invoiceId": 0,
252 "invoiceDisplayId": "string",
253 "invoiceState": "INV_DRAFT",
254 "vendorPaymentId": 0,
255 "purchaseOrderLineItemId": 0,
256 "netAmount": 0,
257 "allowsSystemGenerateNewId": true,
258 "numberRangeIdentifierValue": "string",
259 "numberRangeIdentifierType": {
260 "name": "string"
261 },
262 "numberRangeType": {
263 "name": "string"
264 }
265 }
266 ],
267 "goodsReceiptLineItems": [
268 {
269 "id": 0,
270 "displayId": "string",
271 "quantity": 0,
272 "invoicedQuantity": 0,
273 "description": "string",
274 "expenseCategory": {
275 "id": 0,
276 "displayId": "string",
277 "status": "CREATED",
278 "name": "string",
279 "expenseCategoryType": "PAYMENT"
280 },
281 "goodsReceiptId": 0,
282 "goodsReceiptDisplayId": "string",
283 "goodsReceiptState": "INV_DRAFT",
284 "purchaseOrderLineItemId": 0,
285 "invoiceLineItemLinks": [
286 {
287 "id": 0,
288 "fromId": 0,
289 "toId": 0,
290 "linkedQuantity": 0
291 }
292 ],
293 "allowsSystemGenerateNewId": true,
294 "numberRangeIdentifierValue": "string",
295 "numberRangeIdentifierType": {
296 "name": "string"
297 },
298 "numberRangeType": {
299 "name": "string"
300 }
301 }
302 ],
303 "vendorPaymentId": 0,
304 "purchaseRequisitionLineItemId": 0,
305 "purchaseRequisitionDisplayId": "string",
306 "purchaseRequisitionLineItemAvailableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "quantity": 0,
18 "allocatedQuantity": 0,
19 "unitPrice": 0,
20 "description": "string",
21 "expenseCategory": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "expenseCategoryType": "PAYMENT"
27 },
28 "costCenter": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "validTo": "2019-08-24",
41 "erpSystemId": 0,
42 "erpSystemDisplayId": "string"
43 },
44 "purchaseRequisitionId": 0,
45 "purchaseRequisitionDisplayId": "string",
46 "purchaseOrderLineItems": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "quantity": 0,
51 "allocatedQuantity": 0,
52 "receivedQuantity": 0,
53 "unitPrice": 0,
54 "description": "string",
55 "expenseCategory": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "expenseCategoryType": "PAYMENT"
61 },
62 "costCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "erpSystemId": 0
68 },
69 "profitCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "validTo": "2019-08-24",
75 "erpSystemId": 0,
76 "erpSystemDisplayId": "string"
77 },
78 "taxJurisdiction": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0,
84 "schema": "string",
85 "countryDisplayId": "string"
86 },
87 "taxCode": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "taxLineItems": [
95 {
96 "id": 0,
97 "taxRate": 0.1,
98 "taxAmount": 0,
99 "taxType": "string",
100 "purchaseOrderLineItemId": 0
101 }
102 ],
103 "purchaseOrderId": 0,
104 "purchaseOrderDisplayId": "string",
105 "purchaseOrderState": "INV_DRAFT",
106 "invoiceLineItems": [
107 {
108 "id": 0,
109 "displayId": "string",
110 "expenseCategory": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "expenseCategoryType": "PAYMENT"
116 },
117 "description": "string",
118 "unitOfMeasure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "quantity": 0,
126 "unitPrice": 0,
127 "taxJurisdiction": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "schema": "string",
134 "countryDisplayId": "string"
135 },
136 "taxCode": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "taxExpenseAccount": {
144 "id": 0,
145 "displayId": "string",
146 "generalLedgerAccountName": "string",
147 "generalLedgerAccountCode": "string",
148 "openItemManagement": true,
149 "accountCategory": "BALANCESHEET",
150 "shortName": "string",
151 "longName": "string"
152 },
153 "taxLineItems": [
154 {
155 "id": 0,
156 "taxRate": 0.1,
157 "taxAmount": 0,
158 "taxType": "string",
159 "invoiceLineItemId": 0
160 }
161 ],
162 "workBreakdownStructure": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "costCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "profitCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "validTo": "2019-08-24",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string"
184 },
185 "functionalArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "businessArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "segment": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "network": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrderType": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrder": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0,
226 "internalOrderTypeId": 0
227 },
228 "additionalCurrencies": [
229 {
230 "id": 0,
231 "amount": 0,
232 "currency": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "decimalPoints": 0
238 },
239 "conversionRate": 0,
240 "conversionDate": "2019-08-24",
241 "translationDateType": "DOCUMENT_DATE",
242 "amountType": "NET_AMOUNT",
243 "currencyDefinitionType": "CONTRACT_CURRENCY",
244 "invoiceEntryId": 0,
245 "invoiceEntryDisplayId": "string"
246 }
247 ],
248 "scheduledPaymentMatches": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "amount": 0
254 }
255 ],
256 "goodsReceiptLineItemLinks": [
257 {
258 "id": 0,
259 "fromId": 0,
260 "toId": 0,
261 "linkedQuantity": 0
262 }
263 ],
264 "invoiceId": 0,
265 "invoiceDisplayId": "string",
266 "invoiceState": "INV_DRAFT",
267 "vendorPaymentId": 0,
268 "purchaseOrderLineItemId": 0,
269 "netAmount": 0,
270 "allowsSystemGenerateNewId": true,
271 "numberRangeIdentifierValue": "string",
272 "numberRangeIdentifierType": {
273 "name": "string"
274 },
275 "numberRangeType": {
276 "name": "string"
277 }
278 }
279 ],
280 "goodsReceiptLineItems": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "quantity": 0,
285 "invoicedQuantity": 0,
286 "description": "string",
287 "expenseCategory": {
288 "id": 0,
289 "displayId": "string",
290 "status": "CREATED",
291 "name": "string",
292 "expenseCategoryType": "PAYMENT"
293 },
294 "goodsReceiptId": 0,
295 "goodsReceiptDisplayId": "string",
296 "goodsReceiptState": "INV_DRAFT",
297 "purchaseOrderLineItemId": 0,
298 "invoiceLineItemLinks": [
299 {
300 "id": 0,
301 "fromId": 0,
302 "toId": 0,
303 "linkedQuantity": 0
304 }
305 ],
306 "availableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "vendorPaymentId": 0,
318 "purchaseRequisitionLineItemId": 0,
319 "purchaseRequisitionDisplayId": "string",
320 "purchaseRequisitionLineItemAvailableQuantity": 0,
321 "remainingQuantity": 0,
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/purchase-requisition-item/{id}
📋 Description: Permanently deletes the resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Partially Update A Resource (Json Patch)¶
HTTP Request
PATCH /api/v1/purchase-requisition-item/{id}
📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the purchase requisition item, including quantity, price, and any relevant notes for effective procurement management. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "quantity": 0,
18 "allocatedQuantity": 0,
19 "unitPrice": 0,
20 "description": "string",
21 "expenseCategory": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "expenseCategoryType": "PAYMENT"
27 },
28 "costCenter": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "validTo": "2019-08-24",
41 "erpSystemId": 0,
42 "erpSystemDisplayId": "string"
43 },
44 "purchaseRequisitionId": 0,
45 "purchaseRequisitionDisplayId": "string",
46 "purchaseOrderLineItems": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "quantity": 0,
51 "allocatedQuantity": 0,
52 "receivedQuantity": 0,
53 "unitPrice": 0,
54 "description": "string",
55 "expenseCategory": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "expenseCategoryType": "PAYMENT"
61 },
62 "costCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "erpSystemId": 0
68 },
69 "profitCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "validTo": "2019-08-24",
75 "erpSystemId": 0,
76 "erpSystemDisplayId": "string"
77 },
78 "taxJurisdiction": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0,
84 "schema": "string",
85 "countryDisplayId": "string"
86 },
87 "taxCode": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "taxLineItems": [
95 {
96 "id": 0,
97 "taxRate": 0.1,
98 "taxAmount": 0,
99 "taxType": "string",
100 "purchaseOrderLineItemId": 0
101 }
102 ],
103 "purchaseOrderId": 0,
104 "purchaseOrderDisplayId": "string",
105 "purchaseOrderState": "INV_DRAFT",
106 "invoiceLineItems": [
107 {
108 "id": 0,
109 "displayId": "string",
110 "expenseCategory": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "expenseCategoryType": "PAYMENT"
116 },
117 "description": "string",
118 "unitOfMeasure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "quantity": 0,
126 "unitPrice": 0,
127 "taxJurisdiction": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "schema": "string",
134 "countryDisplayId": "string"
135 },
136 "taxCode": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "taxExpenseAccount": {
144 "id": 0,
145 "displayId": "string",
146 "generalLedgerAccountName": "string",
147 "generalLedgerAccountCode": "string",
148 "openItemManagement": true,
149 "accountCategory": "BALANCESHEET",
150 "shortName": "string",
151 "longName": "string"
152 },
153 "taxLineItems": [
154 {
155 "id": 0,
156 "taxRate": 0.1,
157 "taxAmount": 0,
158 "taxType": "string",
159 "invoiceLineItemId": 0
160 }
161 ],
162 "workBreakdownStructure": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "costCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "profitCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "validTo": "2019-08-24",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string"
184 },
185 "functionalArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "businessArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "segment": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "network": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrderType": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrder": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0,
226 "internalOrderTypeId": 0
227 },
228 "additionalCurrencies": [
229 {
230 "id": 0,
231 "amount": 0,
232 "currency": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "decimalPoints": 0
238 },
239 "conversionRate": 0,
240 "conversionDate": "2019-08-24",
241 "translationDateType": "DOCUMENT_DATE",
242 "amountType": "NET_AMOUNT",
243 "currencyDefinitionType": "CONTRACT_CURRENCY",
244 "invoiceEntryId": 0,
245 "invoiceEntryDisplayId": "string"
246 }
247 ],
248 "scheduledPaymentMatches": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "amount": 0
254 }
255 ],
256 "goodsReceiptLineItemLinks": [
257 {
258 "id": 0,
259 "fromId": 0,
260 "toId": 0,
261 "linkedQuantity": 0
262 }
263 ],
264 "invoiceId": 0,
265 "invoiceDisplayId": "string",
266 "invoiceState": "INV_DRAFT",
267 "vendorPaymentId": 0,
268 "purchaseOrderLineItemId": 0,
269 "netAmount": 0,
270 "allowsSystemGenerateNewId": true,
271 "numberRangeIdentifierValue": "string",
272 "numberRangeIdentifierType": {
273 "name": "string"
274 },
275 "numberRangeType": {
276 "name": "string"
277 }
278 }
279 ],
280 "goodsReceiptLineItems": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "quantity": 0,
285 "invoicedQuantity": 0,
286 "description": "string",
287 "expenseCategory": {
288 "id": 0,
289 "displayId": "string",
290 "status": "CREATED",
291 "name": "string",
292 "expenseCategoryType": "PAYMENT"
293 },
294 "goodsReceiptId": 0,
295 "goodsReceiptDisplayId": "string",
296 "goodsReceiptState": "INV_DRAFT",
297 "purchaseOrderLineItemId": 0,
298 "invoiceLineItemLinks": [
299 {
300 "id": 0,
301 "fromId": 0,
302 "toId": 0,
303 "linkedQuantity": 0
304 }
305 ],
306 "availableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "vendorPaymentId": 0,
318 "purchaseRequisitionLineItemId": 0,
319 "purchaseRequisitionDisplayId": "string",
320 "purchaseRequisitionLineItemAvailableQuantity": 0,
321 "remainingQuantity": 0,
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/purchase-requisition-item/createOrUpdate/bulk
📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully processed items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of purchase requisition item details for bulk creation or update, including item specifications, quantities, and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "purchaseRequisitionId": 0,
33 "purchaseRequisitionDisplayId": "string",
34 "purchaseOrderLineItems": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "quantity": 0,
39 "allocatedQuantity": 0,
40 "receivedQuantity": 0,
41 "unitPrice": 0,
42 "description": "string",
43 "expenseCategory": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "expenseCategoryType": "PAYMENT"
49 },
50 "costCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemId": 0
56 },
57 "profitCenter": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "validTo": "2019-08-24",
63 "erpSystemId": 0,
64 "erpSystemDisplayId": "string"
65 },
66 "taxJurisdiction": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "erpSystemId": 0,
72 "schema": "string",
73 "countryDisplayId": "string"
74 },
75 "taxCode": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "erpSystemId": 0
81 },
82 "taxLineItems": [
83 {
84 "id": 0,
85 "taxRate": 0.1,
86 "taxAmount": 0,
87 "taxType": "string",
88 "purchaseOrderLineItemId": 0
89 }
90 ],
91 "purchaseOrderId": 0,
92 "purchaseOrderDisplayId": "string",
93 "purchaseOrderState": "INV_DRAFT",
94 "invoiceLineItems": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "expenseCategory": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "expenseCategoryType": "PAYMENT"
104 },
105 "description": "string",
106 "unitOfMeasure": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "quantity": 0,
114 "unitPrice": 0,
115 "taxJurisdiction": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "schema": "string",
122 "countryDisplayId": "string"
123 },
124 "taxCode": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "taxExpenseAccount": {
132 "id": 0,
133 "displayId": "string",
134 "generalLedgerAccountName": "string",
135 "generalLedgerAccountCode": "string",
136 "openItemManagement": true,
137 "accountCategory": "BALANCESHEET",
138 "shortName": "string",
139 "longName": "string"
140 },
141 "taxLineItems": [
142 {
143 "id": 0,
144 "taxRate": 0.1,
145 "taxAmount": 0,
146 "taxType": "string",
147 "invoiceLineItemId": 0
148 }
149 ],
150 "workBreakdownStructure": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "costCenter": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "profitCenter": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "validTo": "2019-08-24",
170 "erpSystemId": 0,
171 "erpSystemDisplayId": "string"
172 },
173 "functionalArea": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "businessArea": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "segment": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0
193 },
194 "network": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "internalOrderType": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "internalOrder": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0,
214 "internalOrderTypeId": 0
215 },
216 "additionalCurrencies": [
217 {
218 "id": 0,
219 "amount": 0,
220 "currency": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "decimalPoints": 0
226 },
227 "conversionRate": 0,
228 "conversionDate": "2019-08-24",
229 "translationDateType": "DOCUMENT_DATE",
230 "amountType": "NET_AMOUNT",
231 "currencyDefinitionType": "CONTRACT_CURRENCY",
232 "invoiceEntryId": 0,
233 "invoiceEntryDisplayId": "string"
234 }
235 ],
236 "scheduledPaymentMatches": [
237 {
238 "id": 0,
239 "fromId": 0,
240 "toId": 0,
241 "amount": 0
242 }
243 ],
244 "goodsReceiptLineItemLinks": [
245 {
246 "id": 0,
247 "fromId": 0,
248 "toId": 0,
249 "linkedQuantity": 0
250 }
251 ],
252 "invoiceId": 0,
253 "invoiceDisplayId": "string",
254 "invoiceState": "INV_DRAFT",
255 "vendorPaymentId": 0,
256 "purchaseOrderLineItemId": 0,
257 "netAmount": 0,
258 "allowsSystemGenerateNewId": true,
259 "numberRangeIdentifierValue": "string",
260 "numberRangeIdentifierType": {
261 "name": "string"
262 },
263 "numberRangeType": {
264 "name": "string"
265 }
266 }
267 ],
268 "goodsReceiptLineItems": [
269 {
270 "id": 0,
271 "displayId": "string",
272 "quantity": 0,
273 "invoicedQuantity": 0,
274 "description": "string",
275 "expenseCategory": {
276 "id": 0,
277 "displayId": "string",
278 "status": "CREATED",
279 "name": "string",
280 "expenseCategoryType": "PAYMENT"
281 },
282 "goodsReceiptId": 0,
283 "goodsReceiptDisplayId": "string",
284 "goodsReceiptState": "INV_DRAFT",
285 "purchaseOrderLineItemId": 0,
286 "invoiceLineItemLinks": [
287 {
288 "id": 0,
289 "fromId": 0,
290 "toId": 0,
291 "linkedQuantity": 0
292 }
293 ],
294 "allowsSystemGenerateNewId": true,
295 "numberRangeIdentifierValue": "string",
296 "numberRangeIdentifierType": {
297 "name": "string"
298 },
299 "numberRangeType": {
300 "name": "string"
301 }
302 }
303 ],
304 "vendorPaymentId": 0,
305 "purchaseRequisitionLineItemId": 0,
306 "purchaseRequisitionDisplayId": "string",
307 "purchaseRequisitionLineItemAvailableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "quantity": 0,
19 "allocatedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "purchaseRequisitionId": 0,
46 "purchaseRequisitionDisplayId": "string",
47 "purchaseOrderLineItems": [
48 {
49 "id": 0,
50 "displayId": "string",
51 "quantity": 0,
52 "allocatedQuantity": 0,
53 "receivedQuantity": 0,
54 "unitPrice": 0,
55 "description": "string",
56 "expenseCategory": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "expenseCategoryType": "PAYMENT"
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "taxJurisdiction": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0,
85 "schema": "string",
86 "countryDisplayId": "string"
87 },
88 "taxCode": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "erpSystemId": 0
94 },
95 "taxLineItems": [
96 {
97 "id": 0,
98 "taxRate": 0.1,
99 "taxAmount": 0,
100 "taxType": "string",
101 "purchaseOrderLineItemId": 0
102 }
103 ],
104 "purchaseOrderId": 0,
105 "purchaseOrderDisplayId": "string",
106 "purchaseOrderState": "INV_DRAFT",
107 "invoiceLineItems": [
108 {
109 "id": 0,
110 "displayId": "string",
111 "expenseCategory": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "expenseCategoryType": "PAYMENT"
117 },
118 "description": "string",
119 "unitOfMeasure": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0
125 },
126 "quantity": 0,
127 "unitPrice": 0,
128 "taxJurisdiction": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "schema": "string",
135 "countryDisplayId": "string"
136 },
137 "taxCode": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "taxExpenseAccount": {
145 "id": 0,
146 "displayId": "string",
147 "generalLedgerAccountName": "string",
148 "generalLedgerAccountCode": "string",
149 "openItemManagement": true,
150 "accountCategory": "BALANCESHEET",
151 "shortName": "string",
152 "longName": "string"
153 },
154 "taxLineItems": [
155 {
156 "id": 0,
157 "taxRate": 0.1,
158 "taxAmount": 0,
159 "taxType": "string",
160 "invoiceLineItemId": 0
161 }
162 ],
163 "workBreakdownStructure": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "costCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "erpSystemId": 0
176 },
177 "profitCenter": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "validTo": "2019-08-24",
183 "erpSystemId": 0,
184 "erpSystemDisplayId": "string"
185 },
186 "functionalArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "businessArea": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "segment": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "network": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrderType": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "internalOrder": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0,
227 "internalOrderTypeId": 0
228 },
229 "additionalCurrencies": [
230 {
231 "id": 0,
232 "amount": 0,
233 "currency": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "decimalPoints": 0
239 },
240 "conversionRate": 0,
241 "conversionDate": "2019-08-24",
242 "translationDateType": "DOCUMENT_DATE",
243 "amountType": "NET_AMOUNT",
244 "currencyDefinitionType": "CONTRACT_CURRENCY",
245 "invoiceEntryId": 0,
246 "invoiceEntryDisplayId": "string"
247 }
248 ],
249 "scheduledPaymentMatches": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "amount": 0
255 }
256 ],
257 "goodsReceiptLineItemLinks": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "linkedQuantity": 0
263 }
264 ],
265 "invoiceId": 0,
266 "invoiceDisplayId": "string",
267 "invoiceState": "INV_DRAFT",
268 "vendorPaymentId": 0,
269 "purchaseOrderLineItemId": 0,
270 "netAmount": 0,
271 "allowsSystemGenerateNewId": true,
272 "numberRangeIdentifierValue": "string",
273 "numberRangeIdentifierType": {
274 "name": "string"
275 },
276 "numberRangeType": {
277 "name": "string"
278 }
279 }
280 ],
281 "goodsReceiptLineItems": [
282 {
283 "id": 0,
284 "displayId": "string",
285 "quantity": 0,
286 "invoicedQuantity": 0,
287 "description": "string",
288 "expenseCategory": {
289 "id": 0,
290 "displayId": "string",
291 "status": "CREATED",
292 "name": "string",
293 "expenseCategoryType": "PAYMENT"
294 },
295 "goodsReceiptId": 0,
296 "goodsReceiptDisplayId": "string",
297 "goodsReceiptState": "INV_DRAFT",
298 "purchaseOrderLineItemId": 0,
299 "invoiceLineItemLinks": [
300 {
301 "id": 0,
302 "fromId": 0,
303 "toId": 0,
304 "linkedQuantity": 0
305 }
306 ],
307 "availableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "vendorPaymentId": 0,
319 "purchaseRequisitionLineItemId": 0,
320 "purchaseRequisitionDisplayId": "string",
321 "purchaseRequisitionLineItemAvailableQuantity": 0,
322 "remainingQuantity": 0,
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "availableQuantity": 0,
335 "allowsSystemGenerateNewId": true,
336 "numberRangeIdentifierValue": "string",
337 "numberRangeIdentifierType": {
338 "name": "string"
339 },
340 "numberRangeType": {
341 "name": "string"
342 }
343 }
344 ]
345}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/purchase-requisition-item/createOrUpdate
📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase requisition item details, including item specifications, quantities, and associated metadata for creating or updating requisition records. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "unitPrice": 0,
7 "description": "string",
8 "expenseCategory": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "expenseCategoryType": "PAYMENT"
14 },
15 "costCenter": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "erpSystemId": 0
21 },
22 "profitCenter": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "validTo": "2019-08-24",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string"
30 },
31 "purchaseRequisitionId": 0,
32 "purchaseRequisitionDisplayId": "string",
33 "purchaseOrderLineItems": [
34 {
35 "id": 0,
36 "displayId": "string",
37 "quantity": 0,
38 "allocatedQuantity": 0,
39 "receivedQuantity": 0,
40 "unitPrice": 0,
41 "description": "string",
42 "expenseCategory": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "expenseCategoryType": "PAYMENT"
48 },
49 "costCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "erpSystemId": 0
55 },
56 "profitCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "validTo": "2019-08-24",
62 "erpSystemId": 0,
63 "erpSystemDisplayId": "string"
64 },
65 "taxJurisdiction": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "schema": "string",
72 "countryDisplayId": "string"
73 },
74 "taxCode": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "taxLineItems": [
82 {
83 "id": 0,
84 "taxRate": 0.1,
85 "taxAmount": 0,
86 "taxType": "string",
87 "purchaseOrderLineItemId": 0
88 }
89 ],
90 "purchaseOrderId": 0,
91 "purchaseOrderDisplayId": "string",
92 "purchaseOrderState": "INV_DRAFT",
93 "invoiceLineItems": [
94 {
95 "id": 0,
96 "displayId": "string",
97 "expenseCategory": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "expenseCategoryType": "PAYMENT"
103 },
104 "description": "string",
105 "unitOfMeasure": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0
111 },
112 "quantity": 0,
113 "unitPrice": 0,
114 "taxJurisdiction": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "schema": "string",
121 "countryDisplayId": "string"
122 },
123 "taxCode": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "taxExpenseAccount": {
131 "id": 0,
132 "displayId": "string",
133 "generalLedgerAccountName": "string",
134 "generalLedgerAccountCode": "string",
135 "openItemManagement": true,
136 "accountCategory": "BALANCESHEET",
137 "shortName": "string",
138 "longName": "string"
139 },
140 "taxLineItems": [
141 {
142 "id": 0,
143 "taxRate": 0.1,
144 "taxAmount": 0,
145 "taxType": "string",
146 "invoiceLineItemId": 0
147 }
148 ],
149 "workBreakdownStructure": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string",
154 "erpSystemId": 0
155 },
156 "costCenter": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "profitCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "validTo": "2019-08-24",
169 "erpSystemId": 0,
170 "erpSystemDisplayId": "string"
171 },
172 "functionalArea": {
173 "id": 0,
174 "displayId": "string",
175 "status": "CREATED",
176 "name": "string",
177 "erpSystemId": 0
178 },
179 "businessArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "segment": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "network": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "internalOrderType": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrder": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0,
213 "internalOrderTypeId": 0
214 },
215 "additionalCurrencies": [
216 {
217 "id": 0,
218 "amount": 0,
219 "currency": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "decimalPoints": 0
225 },
226 "conversionRate": 0,
227 "conversionDate": "2019-08-24",
228 "translationDateType": "DOCUMENT_DATE",
229 "amountType": "NET_AMOUNT",
230 "currencyDefinitionType": "CONTRACT_CURRENCY",
231 "invoiceEntryId": 0,
232 "invoiceEntryDisplayId": "string"
233 }
234 ],
235 "scheduledPaymentMatches": [
236 {
237 "id": 0,
238 "fromId": 0,
239 "toId": 0,
240 "amount": 0
241 }
242 ],
243 "goodsReceiptLineItemLinks": [
244 {
245 "id": 0,
246 "fromId": 0,
247 "toId": 0,
248 "linkedQuantity": 0
249 }
250 ],
251 "invoiceId": 0,
252 "invoiceDisplayId": "string",
253 "invoiceState": "INV_DRAFT",
254 "vendorPaymentId": 0,
255 "purchaseOrderLineItemId": 0,
256 "netAmount": 0,
257 "allowsSystemGenerateNewId": true,
258 "numberRangeIdentifierValue": "string",
259 "numberRangeIdentifierType": {
260 "name": "string"
261 },
262 "numberRangeType": {
263 "name": "string"
264 }
265 }
266 ],
267 "goodsReceiptLineItems": [
268 {
269 "id": 0,
270 "displayId": "string",
271 "quantity": 0,
272 "invoicedQuantity": 0,
273 "description": "string",
274 "expenseCategory": {
275 "id": 0,
276 "displayId": "string",
277 "status": "CREATED",
278 "name": "string",
279 "expenseCategoryType": "PAYMENT"
280 },
281 "goodsReceiptId": 0,
282 "goodsReceiptDisplayId": "string",
283 "goodsReceiptState": "INV_DRAFT",
284 "purchaseOrderLineItemId": 0,
285 "invoiceLineItemLinks": [
286 {
287 "id": 0,
288 "fromId": 0,
289 "toId": 0,
290 "linkedQuantity": 0
291 }
292 ],
293 "allowsSystemGenerateNewId": true,
294 "numberRangeIdentifierValue": "string",
295 "numberRangeIdentifierType": {
296 "name": "string"
297 },
298 "numberRangeType": {
299 "name": "string"
300 }
301 }
302 ],
303 "vendorPaymentId": 0,
304 "purchaseRequisitionLineItemId": 0,
305 "purchaseRequisitionDisplayId": "string",
306 "purchaseRequisitionLineItemAvailableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "quantity": 0,
18 "allocatedQuantity": 0,
19 "unitPrice": 0,
20 "description": "string",
21 "expenseCategory": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "expenseCategoryType": "PAYMENT"
27 },
28 "costCenter": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "validTo": "2019-08-24",
41 "erpSystemId": 0,
42 "erpSystemDisplayId": "string"
43 },
44 "purchaseRequisitionId": 0,
45 "purchaseRequisitionDisplayId": "string",
46 "purchaseOrderLineItems": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "quantity": 0,
51 "allocatedQuantity": 0,
52 "receivedQuantity": 0,
53 "unitPrice": 0,
54 "description": "string",
55 "expenseCategory": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "expenseCategoryType": "PAYMENT"
61 },
62 "costCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "erpSystemId": 0
68 },
69 "profitCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "validTo": "2019-08-24",
75 "erpSystemId": 0,
76 "erpSystemDisplayId": "string"
77 },
78 "taxJurisdiction": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0,
84 "schema": "string",
85 "countryDisplayId": "string"
86 },
87 "taxCode": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "taxLineItems": [
95 {
96 "id": 0,
97 "taxRate": 0.1,
98 "taxAmount": 0,
99 "taxType": "string",
100 "purchaseOrderLineItemId": 0
101 }
102 ],
103 "purchaseOrderId": 0,
104 "purchaseOrderDisplayId": "string",
105 "purchaseOrderState": "INV_DRAFT",
106 "invoiceLineItems": [
107 {
108 "id": 0,
109 "displayId": "string",
110 "expenseCategory": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "expenseCategoryType": "PAYMENT"
116 },
117 "description": "string",
118 "unitOfMeasure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "quantity": 0,
126 "unitPrice": 0,
127 "taxJurisdiction": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "schema": "string",
134 "countryDisplayId": "string"
135 },
136 "taxCode": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "taxExpenseAccount": {
144 "id": 0,
145 "displayId": "string",
146 "generalLedgerAccountName": "string",
147 "generalLedgerAccountCode": "string",
148 "openItemManagement": true,
149 "accountCategory": "BALANCESHEET",
150 "shortName": "string",
151 "longName": "string"
152 },
153 "taxLineItems": [
154 {
155 "id": 0,
156 "taxRate": 0.1,
157 "taxAmount": 0,
158 "taxType": "string",
159 "invoiceLineItemId": 0
160 }
161 ],
162 "workBreakdownStructure": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "costCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "profitCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "validTo": "2019-08-24",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string"
184 },
185 "functionalArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "businessArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "segment": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "network": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrderType": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrder": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0,
226 "internalOrderTypeId": 0
227 },
228 "additionalCurrencies": [
229 {
230 "id": 0,
231 "amount": 0,
232 "currency": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "decimalPoints": 0
238 },
239 "conversionRate": 0,
240 "conversionDate": "2019-08-24",
241 "translationDateType": "DOCUMENT_DATE",
242 "amountType": "NET_AMOUNT",
243 "currencyDefinitionType": "CONTRACT_CURRENCY",
244 "invoiceEntryId": 0,
245 "invoiceEntryDisplayId": "string"
246 }
247 ],
248 "scheduledPaymentMatches": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "amount": 0
254 }
255 ],
256 "goodsReceiptLineItemLinks": [
257 {
258 "id": 0,
259 "fromId": 0,
260 "toId": 0,
261 "linkedQuantity": 0
262 }
263 ],
264 "invoiceId": 0,
265 "invoiceDisplayId": "string",
266 "invoiceState": "INV_DRAFT",
267 "vendorPaymentId": 0,
268 "purchaseOrderLineItemId": 0,
269 "netAmount": 0,
270 "allowsSystemGenerateNewId": true,
271 "numberRangeIdentifierValue": "string",
272 "numberRangeIdentifierType": {
273 "name": "string"
274 },
275 "numberRangeType": {
276 "name": "string"
277 }
278 }
279 ],
280 "goodsReceiptLineItems": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "quantity": 0,
285 "invoicedQuantity": 0,
286 "description": "string",
287 "expenseCategory": {
288 "id": 0,
289 "displayId": "string",
290 "status": "CREATED",
291 "name": "string",
292 "expenseCategoryType": "PAYMENT"
293 },
294 "goodsReceiptId": 0,
295 "goodsReceiptDisplayId": "string",
296 "goodsReceiptState": "INV_DRAFT",
297 "purchaseOrderLineItemId": 0,
298 "invoiceLineItemLinks": [
299 {
300 "id": 0,
301 "fromId": 0,
302 "toId": 0,
303 "linkedQuantity": 0
304 }
305 ],
306 "availableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "vendorPaymentId": 0,
318 "purchaseRequisitionLineItemId": 0,
319 "purchaseRequisitionDisplayId": "string",
320 "purchaseRequisitionLineItemAvailableQuantity": 0,
321 "remainingQuantity": 0,
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/purchase-requisition-item/bulk
📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response
errorslist. The response body always contains the successfully updated items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of purchase requisition item details for bulk updates, including item identifiers, quantities, and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "purchaseRequisitionId": 0,
33 "purchaseRequisitionDisplayId": "string",
34 "purchaseOrderLineItems": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "quantity": 0,
39 "allocatedQuantity": 0,
40 "receivedQuantity": 0,
41 "unitPrice": 0,
42 "description": "string",
43 "expenseCategory": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "expenseCategoryType": "PAYMENT"
49 },
50 "costCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemId": 0
56 },
57 "profitCenter": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "validTo": "2019-08-24",
63 "erpSystemId": 0,
64 "erpSystemDisplayId": "string"
65 },
66 "taxJurisdiction": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "erpSystemId": 0,
72 "schema": "string",
73 "countryDisplayId": "string"
74 },
75 "taxCode": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "erpSystemId": 0
81 },
82 "taxLineItems": [
83 {
84 "id": 0,
85 "taxRate": 0.1,
86 "taxAmount": 0,
87 "taxType": "string",
88 "purchaseOrderLineItemId": 0
89 }
90 ],
91 "purchaseOrderId": 0,
92 "purchaseOrderDisplayId": "string",
93 "purchaseOrderState": "INV_DRAFT",
94 "invoiceLineItems": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "expenseCategory": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "expenseCategoryType": "PAYMENT"
104 },
105 "description": "string",
106 "unitOfMeasure": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "quantity": 0,
114 "unitPrice": 0,
115 "taxJurisdiction": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "schema": "string",
122 "countryDisplayId": "string"
123 },
124 "taxCode": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "taxExpenseAccount": {
132 "id": 0,
133 "displayId": "string",
134 "generalLedgerAccountName": "string",
135 "generalLedgerAccountCode": "string",
136 "openItemManagement": true,
137 "accountCategory": "BALANCESHEET",
138 "shortName": "string",
139 "longName": "string"
140 },
141 "taxLineItems": [
142 {
143 "id": 0,
144 "taxRate": 0.1,
145 "taxAmount": 0,
146 "taxType": "string",
147 "invoiceLineItemId": 0
148 }
149 ],
150 "workBreakdownStructure": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "costCenter": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "profitCenter": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "validTo": "2019-08-24",
170 "erpSystemId": 0,
171 "erpSystemDisplayId": "string"
172 },
173 "functionalArea": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "businessArea": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "segment": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0
193 },
194 "network": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "internalOrderType": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "internalOrder": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0,
214 "internalOrderTypeId": 0
215 },
216 "additionalCurrencies": [
217 {
218 "id": 0,
219 "amount": 0,
220 "currency": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "decimalPoints": 0
226 },
227 "conversionRate": 0,
228 "conversionDate": "2019-08-24",
229 "translationDateType": "DOCUMENT_DATE",
230 "amountType": "NET_AMOUNT",
231 "currencyDefinitionType": "CONTRACT_CURRENCY",
232 "invoiceEntryId": 0,
233 "invoiceEntryDisplayId": "string"
234 }
235 ],
236 "scheduledPaymentMatches": [
237 {
238 "id": 0,
239 "fromId": 0,
240 "toId": 0,
241 "amount": 0
242 }
243 ],
244 "goodsReceiptLineItemLinks": [
245 {
246 "id": 0,
247 "fromId": 0,
248 "toId": 0,
249 "linkedQuantity": 0
250 }
251 ],
252 "invoiceId": 0,
253 "invoiceDisplayId": "string",
254 "invoiceState": "INV_DRAFT",
255 "vendorPaymentId": 0,
256 "purchaseOrderLineItemId": 0,
257 "netAmount": 0,
258 "allowsSystemGenerateNewId": true,
259 "numberRangeIdentifierValue": "string",
260 "numberRangeIdentifierType": {
261 "name": "string"
262 },
263 "numberRangeType": {
264 "name": "string"
265 }
266 }
267 ],
268 "goodsReceiptLineItems": [
269 {
270 "id": 0,
271 "displayId": "string",
272 "quantity": 0,
273 "invoicedQuantity": 0,
274 "description": "string",
275 "expenseCategory": {
276 "id": 0,
277 "displayId": "string",
278 "status": "CREATED",
279 "name": "string",
280 "expenseCategoryType": "PAYMENT"
281 },
282 "goodsReceiptId": 0,
283 "goodsReceiptDisplayId": "string",
284 "goodsReceiptState": "INV_DRAFT",
285 "purchaseOrderLineItemId": 0,
286 "invoiceLineItemLinks": [
287 {
288 "id": 0,
289 "fromId": 0,
290 "toId": 0,
291 "linkedQuantity": 0
292 }
293 ],
294 "allowsSystemGenerateNewId": true,
295 "numberRangeIdentifierValue": "string",
296 "numberRangeIdentifierType": {
297 "name": "string"
298 },
299 "numberRangeType": {
300 "name": "string"
301 }
302 }
303 ],
304 "vendorPaymentId": 0,
305 "purchaseRequisitionLineItemId": 0,
306 "purchaseRequisitionDisplayId": "string",
307 "purchaseRequisitionLineItemAvailableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "quantity": 0,
19 "allocatedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "purchaseRequisitionId": 0,
46 "purchaseRequisitionDisplayId": "string",
47 "purchaseOrderLineItems": [
48 {
49 "id": 0,
50 "displayId": "string",
51 "quantity": 0,
52 "allocatedQuantity": 0,
53 "receivedQuantity": 0,
54 "unitPrice": 0,
55 "description": "string",
56 "expenseCategory": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "expenseCategoryType": "PAYMENT"
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "taxJurisdiction": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0,
85 "schema": "string",
86 "countryDisplayId": "string"
87 },
88 "taxCode": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "erpSystemId": 0
94 },
95 "taxLineItems": [
96 {
97 "id": 0,
98 "taxRate": 0.1,
99 "taxAmount": 0,
100 "taxType": "string",
101 "purchaseOrderLineItemId": 0
102 }
103 ],
104 "purchaseOrderId": 0,
105 "purchaseOrderDisplayId": "string",
106 "purchaseOrderState": "INV_DRAFT",
107 "invoiceLineItems": [
108 {
109 "id": 0,
110 "displayId": "string",
111 "expenseCategory": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "expenseCategoryType": "PAYMENT"
117 },
118 "description": "string",
119 "unitOfMeasure": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0
125 },
126 "quantity": 0,
127 "unitPrice": 0,
128 "taxJurisdiction": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "schema": "string",
135 "countryDisplayId": "string"
136 },
137 "taxCode": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "taxExpenseAccount": {
145 "id": 0,
146 "displayId": "string",
147 "generalLedgerAccountName": "string",
148 "generalLedgerAccountCode": "string",
149 "openItemManagement": true,
150 "accountCategory": "BALANCESHEET",
151 "shortName": "string",
152 "longName": "string"
153 },
154 "taxLineItems": [
155 {
156 "id": 0,
157 "taxRate": 0.1,
158 "taxAmount": 0,
159 "taxType": "string",
160 "invoiceLineItemId": 0
161 }
162 ],
163 "workBreakdownStructure": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "costCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "erpSystemId": 0
176 },
177 "profitCenter": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "validTo": "2019-08-24",
183 "erpSystemId": 0,
184 "erpSystemDisplayId": "string"
185 },
186 "functionalArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "businessArea": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "segment": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "network": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrderType": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "internalOrder": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0,
227 "internalOrderTypeId": 0
228 },
229 "additionalCurrencies": [
230 {
231 "id": 0,
232 "amount": 0,
233 "currency": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "decimalPoints": 0
239 },
240 "conversionRate": 0,
241 "conversionDate": "2019-08-24",
242 "translationDateType": "DOCUMENT_DATE",
243 "amountType": "NET_AMOUNT",
244 "currencyDefinitionType": "CONTRACT_CURRENCY",
245 "invoiceEntryId": 0,
246 "invoiceEntryDisplayId": "string"
247 }
248 ],
249 "scheduledPaymentMatches": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "amount": 0
255 }
256 ],
257 "goodsReceiptLineItemLinks": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "linkedQuantity": 0
263 }
264 ],
265 "invoiceId": 0,
266 "invoiceDisplayId": "string",
267 "invoiceState": "INV_DRAFT",
268 "vendorPaymentId": 0,
269 "purchaseOrderLineItemId": 0,
270 "netAmount": 0,
271 "allowsSystemGenerateNewId": true,
272 "numberRangeIdentifierValue": "string",
273 "numberRangeIdentifierType": {
274 "name": "string"
275 },
276 "numberRangeType": {
277 "name": "string"
278 }
279 }
280 ],
281 "goodsReceiptLineItems": [
282 {
283 "id": 0,
284 "displayId": "string",
285 "quantity": 0,
286 "invoicedQuantity": 0,
287 "description": "string",
288 "expenseCategory": {
289 "id": 0,
290 "displayId": "string",
291 "status": "CREATED",
292 "name": "string",
293 "expenseCategoryType": "PAYMENT"
294 },
295 "goodsReceiptId": 0,
296 "goodsReceiptDisplayId": "string",
297 "goodsReceiptState": "INV_DRAFT",
298 "purchaseOrderLineItemId": 0,
299 "invoiceLineItemLinks": [
300 {
301 "id": 0,
302 "fromId": 0,
303 "toId": 0,
304 "linkedQuantity": 0
305 }
306 ],
307 "availableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "vendorPaymentId": 0,
319 "purchaseRequisitionLineItemId": 0,
320 "purchaseRequisitionDisplayId": "string",
321 "purchaseRequisitionLineItemAvailableQuantity": 0,
322 "remainingQuantity": 0,
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "availableQuantity": 0,
335 "allowsSystemGenerateNewId": true,
336 "numberRangeIdentifierValue": "string",
337 "numberRangeIdentifierType": {
338 "name": "string"
339 },
340 "numberRangeType": {
341 "name": "string"
342 }
343 }
344 ]
345}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/purchase-requisition-item/bulk
📋 Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully created items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of purchase requisition items, each including details such as item description, quantity, and pricing information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "purchaseRequisitionId": 0,
33 "purchaseRequisitionDisplayId": "string",
34 "purchaseOrderLineItems": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "quantity": 0,
39 "allocatedQuantity": 0,
40 "receivedQuantity": 0,
41 "unitPrice": 0,
42 "description": "string",
43 "expenseCategory": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "expenseCategoryType": "PAYMENT"
49 },
50 "costCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemId": 0
56 },
57 "profitCenter": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "validTo": "2019-08-24",
63 "erpSystemId": 0,
64 "erpSystemDisplayId": "string"
65 },
66 "taxJurisdiction": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "erpSystemId": 0,
72 "schema": "string",
73 "countryDisplayId": "string"
74 },
75 "taxCode": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "erpSystemId": 0
81 },
82 "taxLineItems": [
83 {
84 "id": 0,
85 "taxRate": 0.1,
86 "taxAmount": 0,
87 "taxType": "string",
88 "purchaseOrderLineItemId": 0
89 }
90 ],
91 "purchaseOrderId": 0,
92 "purchaseOrderDisplayId": "string",
93 "purchaseOrderState": "INV_DRAFT",
94 "invoiceLineItems": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "expenseCategory": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "expenseCategoryType": "PAYMENT"
104 },
105 "description": "string",
106 "unitOfMeasure": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "quantity": 0,
114 "unitPrice": 0,
115 "taxJurisdiction": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "schema": "string",
122 "countryDisplayId": "string"
123 },
124 "taxCode": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "taxExpenseAccount": {
132 "id": 0,
133 "displayId": "string",
134 "generalLedgerAccountName": "string",
135 "generalLedgerAccountCode": "string",
136 "openItemManagement": true,
137 "accountCategory": "BALANCESHEET",
138 "shortName": "string",
139 "longName": "string"
140 },
141 "taxLineItems": [
142 {
143 "id": 0,
144 "taxRate": 0.1,
145 "taxAmount": 0,
146 "taxType": "string",
147 "invoiceLineItemId": 0
148 }
149 ],
150 "workBreakdownStructure": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "costCenter": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "profitCenter": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "validTo": "2019-08-24",
170 "erpSystemId": 0,
171 "erpSystemDisplayId": "string"
172 },
173 "functionalArea": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "businessArea": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "segment": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0
193 },
194 "network": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "internalOrderType": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "internalOrder": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0,
214 "internalOrderTypeId": 0
215 },
216 "additionalCurrencies": [
217 {
218 "id": 0,
219 "amount": 0,
220 "currency": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "decimalPoints": 0
226 },
227 "conversionRate": 0,
228 "conversionDate": "2019-08-24",
229 "translationDateType": "DOCUMENT_DATE",
230 "amountType": "NET_AMOUNT",
231 "currencyDefinitionType": "CONTRACT_CURRENCY",
232 "invoiceEntryId": 0,
233 "invoiceEntryDisplayId": "string"
234 }
235 ],
236 "scheduledPaymentMatches": [
237 {
238 "id": 0,
239 "fromId": 0,
240 "toId": 0,
241 "amount": 0
242 }
243 ],
244 "goodsReceiptLineItemLinks": [
245 {
246 "id": 0,
247 "fromId": 0,
248 "toId": 0,
249 "linkedQuantity": 0
250 }
251 ],
252 "invoiceId": 0,
253 "invoiceDisplayId": "string",
254 "invoiceState": "INV_DRAFT",
255 "vendorPaymentId": 0,
256 "purchaseOrderLineItemId": 0,
257 "netAmount": 0,
258 "allowsSystemGenerateNewId": true,
259 "numberRangeIdentifierValue": "string",
260 "numberRangeIdentifierType": {
261 "name": "string"
262 },
263 "numberRangeType": {
264 "name": "string"
265 }
266 }
267 ],
268 "goodsReceiptLineItems": [
269 {
270 "id": 0,
271 "displayId": "string",
272 "quantity": 0,
273 "invoicedQuantity": 0,
274 "description": "string",
275 "expenseCategory": {
276 "id": 0,
277 "displayId": "string",
278 "status": "CREATED",
279 "name": "string",
280 "expenseCategoryType": "PAYMENT"
281 },
282 "goodsReceiptId": 0,
283 "goodsReceiptDisplayId": "string",
284 "goodsReceiptState": "INV_DRAFT",
285 "purchaseOrderLineItemId": 0,
286 "invoiceLineItemLinks": [
287 {
288 "id": 0,
289 "fromId": 0,
290 "toId": 0,
291 "linkedQuantity": 0
292 }
293 ],
294 "allowsSystemGenerateNewId": true,
295 "numberRangeIdentifierValue": "string",
296 "numberRangeIdentifierType": {
297 "name": "string"
298 },
299 "numberRangeType": {
300 "name": "string"
301 }
302 }
303 ],
304 "vendorPaymentId": 0,
305 "purchaseRequisitionLineItemId": 0,
306 "purchaseRequisitionDisplayId": "string",
307 "purchaseRequisitionLineItemAvailableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "quantity": 0,
19 "allocatedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "purchaseRequisitionId": 0,
46 "purchaseRequisitionDisplayId": "string",
47 "purchaseOrderLineItems": [
48 {
49 "id": 0,
50 "displayId": "string",
51 "quantity": 0,
52 "allocatedQuantity": 0,
53 "receivedQuantity": 0,
54 "unitPrice": 0,
55 "description": "string",
56 "expenseCategory": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "expenseCategoryType": "PAYMENT"
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "taxJurisdiction": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0,
85 "schema": "string",
86 "countryDisplayId": "string"
87 },
88 "taxCode": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "erpSystemId": 0
94 },
95 "taxLineItems": [
96 {
97 "id": 0,
98 "taxRate": 0.1,
99 "taxAmount": 0,
100 "taxType": "string",
101 "purchaseOrderLineItemId": 0
102 }
103 ],
104 "purchaseOrderId": 0,
105 "purchaseOrderDisplayId": "string",
106 "purchaseOrderState": "INV_DRAFT",
107 "invoiceLineItems": [
108 {
109 "id": 0,
110 "displayId": "string",
111 "expenseCategory": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "expenseCategoryType": "PAYMENT"
117 },
118 "description": "string",
119 "unitOfMeasure": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0
125 },
126 "quantity": 0,
127 "unitPrice": 0,
128 "taxJurisdiction": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "schema": "string",
135 "countryDisplayId": "string"
136 },
137 "taxCode": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "taxExpenseAccount": {
145 "id": 0,
146 "displayId": "string",
147 "generalLedgerAccountName": "string",
148 "generalLedgerAccountCode": "string",
149 "openItemManagement": true,
150 "accountCategory": "BALANCESHEET",
151 "shortName": "string",
152 "longName": "string"
153 },
154 "taxLineItems": [
155 {
156 "id": 0,
157 "taxRate": 0.1,
158 "taxAmount": 0,
159 "taxType": "string",
160 "invoiceLineItemId": 0
161 }
162 ],
163 "workBreakdownStructure": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "costCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "erpSystemId": 0
176 },
177 "profitCenter": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "validTo": "2019-08-24",
183 "erpSystemId": 0,
184 "erpSystemDisplayId": "string"
185 },
186 "functionalArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "businessArea": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "segment": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "network": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrderType": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "internalOrder": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0,
227 "internalOrderTypeId": 0
228 },
229 "additionalCurrencies": [
230 {
231 "id": 0,
232 "amount": 0,
233 "currency": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "decimalPoints": 0
239 },
240 "conversionRate": 0,
241 "conversionDate": "2019-08-24",
242 "translationDateType": "DOCUMENT_DATE",
243 "amountType": "NET_AMOUNT",
244 "currencyDefinitionType": "CONTRACT_CURRENCY",
245 "invoiceEntryId": 0,
246 "invoiceEntryDisplayId": "string"
247 }
248 ],
249 "scheduledPaymentMatches": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "amount": 0
255 }
256 ],
257 "goodsReceiptLineItemLinks": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "linkedQuantity": 0
263 }
264 ],
265 "invoiceId": 0,
266 "invoiceDisplayId": "string",
267 "invoiceState": "INV_DRAFT",
268 "vendorPaymentId": 0,
269 "purchaseOrderLineItemId": 0,
270 "netAmount": 0,
271 "allowsSystemGenerateNewId": true,
272 "numberRangeIdentifierValue": "string",
273 "numberRangeIdentifierType": {
274 "name": "string"
275 },
276 "numberRangeType": {
277 "name": "string"
278 }
279 }
280 ],
281 "goodsReceiptLineItems": [
282 {
283 "id": 0,
284 "displayId": "string",
285 "quantity": 0,
286 "invoicedQuantity": 0,
287 "description": "string",
288 "expenseCategory": {
289 "id": 0,
290 "displayId": "string",
291 "status": "CREATED",
292 "name": "string",
293 "expenseCategoryType": "PAYMENT"
294 },
295 "goodsReceiptId": 0,
296 "goodsReceiptDisplayId": "string",
297 "goodsReceiptState": "INV_DRAFT",
298 "purchaseOrderLineItemId": 0,
299 "invoiceLineItemLinks": [
300 {
301 "id": 0,
302 "fromId": 0,
303 "toId": 0,
304 "linkedQuantity": 0
305 }
306 ],
307 "availableQuantity": 0,
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierValue": "string",
310 "numberRangeIdentifierType": {
311 "name": "string"
312 },
313 "numberRangeType": {
314 "name": "string"
315 }
316 }
317 ],
318 "vendorPaymentId": 0,
319 "purchaseRequisitionLineItemId": 0,
320 "purchaseRequisitionDisplayId": "string",
321 "purchaseRequisitionLineItemAvailableQuantity": 0,
322 "remainingQuantity": 0,
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "availableQuantity": 0,
335 "allowsSystemGenerateNewId": true,
336 "numberRangeIdentifierValue": "string",
337 "numberRangeIdentifierType": {
338 "name": "string"
339 },
340 "numberRangeType": {
341 "name": "string"
342 }
343 }
344 ]
345}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/purchase-requisition-item/bulk
📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A
ValidationExceptioncontaining per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of purchase requisition item identifiers to facilitate bulk deletion of specified items from the procurement system. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search Resources¶
HTTP Request
POST /api/v1/purchase-requisition-item/search
📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.
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 |
false |
Request body containing the search criteria and filters for retrieving purchase requisition items, enabling efficient procurement management. |
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 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "displayIdIn": [
16 "string"
17 ],
18 "displayIdLike": "string",
19 "quantityEqual": 0,
20 "allocatedQuantityEqual": 0,
21 "unitPriceEqual": 0,
22 "descriptionLike": "string",
23 "expenseCategoryIdEqual": 0,
24 "expenseCategoryDisplayIdLike": "string",
25 "costCenterIdEqual": 0,
26 "costCenterDisplayIdLike": "string",
27 "costCenterNameLike": "string",
28 "profitCenterIdEqual": 0,
29 "profitCenterDisplayIdLike": "string",
30 "profitCenterNameLike": "string",
31 "purchaseRequisitionIdIn": [
32 0
33 ],
34 "purchaseRequisitionIdEqual": 0,
35 "purchaseRequisitionDisplayIdIn": [
36 "string"
37 ],
38 "purchaseRequisitionDisplayIdEqual": "string",
39 "purchaseOrderLineItemsIdIn": [
40 0
41 ]
42}
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 "id": 0,
21 "displayId": "string",
22 "quantity": 0,
23 "allocatedQuantity": 0,
24 "unitPrice": 0,
25 "description": "string",
26 "expenseCategory": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "expenseCategoryType": "PAYMENT"
32 },
33 "costCenter": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0
39 },
40 "profitCenter": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "validTo": "2019-08-24",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string"
48 },
49 "purchaseRequisitionId": 0,
50 "purchaseRequisitionDisplayId": "string",
51 "purchaseOrderLineItems": [
52 {
53 "id": 0,
54 "displayId": "string",
55 "quantity": 0,
56 "allocatedQuantity": 0,
57 "receivedQuantity": 0,
58 "unitPrice": 0,
59 "description": "string",
60 "expenseCategory": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "expenseCategoryType": "PAYMENT"
66 },
67 "costCenter": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "erpSystemId": 0
73 },
74 "profitCenter": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "validTo": "2019-08-24",
80 "erpSystemId": 0,
81 "erpSystemDisplayId": "string"
82 },
83 "taxJurisdiction": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "erpSystemId": 0,
89 "schema": "string",
90 "countryDisplayId": "string"
91 },
92 "taxCode": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "taxLineItems": [
100 {
101 "id": 0,
102 "taxRate": 0.1,
103 "taxAmount": 0,
104 "taxType": "string",
105 "purchaseOrderLineItemId": 0
106 }
107 ],
108 "purchaseOrderId": 0,
109 "purchaseOrderDisplayId": "string",
110 "purchaseOrderState": "INV_DRAFT",
111 "invoiceLineItems": [
112 {
113 "id": 0,
114 "displayId": "string",
115 "expenseCategory": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "expenseCategoryType": "PAYMENT"
121 },
122 "description": "string",
123 "unitOfMeasure": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "quantity": 0,
131 "unitPrice": 0,
132 "taxJurisdiction": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0,
138 "schema": "string",
139 "countryDisplayId": "string"
140 },
141 "taxCode": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0
147 },
148 "taxExpenseAccount": {
149 "id": 0,
150 "displayId": "string",
151 "generalLedgerAccountName": "string",
152 "generalLedgerAccountCode": "string",
153 "openItemManagement": true,
154 "accountCategory": "BALANCESHEET",
155 "shortName": "string",
156 "longName": "string"
157 },
158 "taxLineItems": [
159 {
160 "id": 0,
161 "taxRate": 0.1,
162 "taxAmount": 0,
163 "taxType": "string",
164 "invoiceLineItemId": 0
165 }
166 ],
167 "workBreakdownStructure": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "costCenter": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "profitCenter": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "validTo": "2019-08-24",
187 "erpSystemId": 0,
188 "erpSystemDisplayId": "string"
189 },
190 "functionalArea": {
191 "id": 0,
192 "displayId": "string",
193 "status": "CREATED",
194 "name": "string",
195 "erpSystemId": 0
196 },
197 "businessArea": {
198 "id": 0,
199 "displayId": "string",
200 "status": "CREATED",
201 "name": "string",
202 "erpSystemId": 0
203 },
204 "segment": {
205 "id": 0,
206 "displayId": "string",
207 "status": "CREATED",
208 "name": "string",
209 "erpSystemId": 0
210 },
211 "network": {
212 "id": 0,
213 "displayId": "string",
214 "status": "CREATED",
215 "name": "string",
216 "erpSystemId": 0
217 },
218 "internalOrderType": {
219 "id": 0,
220 "displayId": "string",
221 "status": "CREATED",
222 "name": "string",
223 "erpSystemId": 0
224 },
225 "internalOrder": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "erpSystemId": 0,
231 "internalOrderTypeId": 0
232 },
233 "additionalCurrencies": [
234 {
235 "id": 0,
236 "amount": 0,
237 "currency": {
238 "id": 0,
239 "displayId": "string",
240 "status": "CREATED",
241 "name": "string",
242 "decimalPoints": 0
243 },
244 "conversionRate": 0,
245 "conversionDate": "2019-08-24",
246 "translationDateType": "DOCUMENT_DATE",
247 "amountType": "NET_AMOUNT",
248 "currencyDefinitionType": "CONTRACT_CURRENCY",
249 "invoiceEntryId": 0,
250 "invoiceEntryDisplayId": "string"
251 }
252 ],
253 "scheduledPaymentMatches": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "amount": 0
259 }
260 ],
261 "goodsReceiptLineItemLinks": [
262 {
263 "id": 0,
264 "fromId": 0,
265 "toId": 0,
266 "linkedQuantity": 0
267 }
268 ],
269 "invoiceId": 0,
270 "invoiceDisplayId": "string",
271 "invoiceState": "INV_DRAFT",
272 "vendorPaymentId": 0,
273 "purchaseOrderLineItemId": 0,
274 "netAmount": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284 ],
285 "goodsReceiptLineItems": [
286 {
287 "id": 0,
288 "displayId": "string",
289 "quantity": 0,
290 "invoicedQuantity": 0,
291 "description": "string",
292 "expenseCategory": {
293 "id": 0,
294 "displayId": "string",
295 "status": "CREATED",
296 "name": "string",
297 "expenseCategoryType": "PAYMENT"
298 },
299 "goodsReceiptId": 0,
300 "goodsReceiptDisplayId": "string",
301 "goodsReceiptState": "INV_DRAFT",
302 "purchaseOrderLineItemId": 0,
303 "invoiceLineItemLinks": [
304 {
305 "id": 0,
306 "fromId": 0,
307 "toId": 0,
308 "linkedQuantity": 0
309 }
310 ],
311 "availableQuantity": 0,
312 "allowsSystemGenerateNewId": true,
313 "numberRangeIdentifierValue": "string",
314 "numberRangeIdentifierType": {
315 "name": "string"
316 },
317 "numberRangeType": {
318 "name": "string"
319 }
320 }
321 ],
322 "vendorPaymentId": 0,
323 "purchaseRequisitionLineItemId": 0,
324 "purchaseRequisitionDisplayId": "string",
325 "purchaseRequisitionLineItemAvailableQuantity": 0,
326 "remainingQuantity": 0,
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "availableQuantity": 0,
339 "allowsSystemGenerateNewId": true,
340 "numberRangeIdentifierValue": "string",
341 "numberRangeIdentifierType": {
342 "name": "string"
343 },
344 "numberRangeType": {
345 "name": "string"
346 }
347 }
348 ],
349 "number": 0,
350 "sort": {
351 "unsorted": true,
352 "sorted": true,
353 "empty": true
354 },
355 "first": true,
356 "last": true,
357 "empty": true
358}
Purchase Requisition Line Item - Advanced Search¶
HTTP Request
POST /api/v1/purchase-requisition-item/advanced-search
📋 Description: Submits a request to perform an advanced search for purchase requisition items, allowing users to refine their search criteria to efficiently locate specific items within the procurement system.
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 advanced search criteria for purchase requisition items, including filters such as item category, supplier information, and status to facilitate targeted procurement analysis. |
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 "facets": [
3 "ID"
4 ],
5 "facetSelections": {
6 "property1": [
7 "string"
8 ],
9 "property2": [
10 "string"
11 ]
12 },
13 "aggregations": {
14 "property1": {
15 "type": "TERMS",
16 "field": "ID",
17 "size": 0,
18 "missing": "string"
19 },
20 "property2": {
21 "type": "TERMS",
22 "field": "ID",
23 "size": 0,
24 "missing": "string"
25 }
26 },
27 "filter": {
28 "operator": "AND",
29 "children": [
30 {}
31 ],
32 "field": "ID",
33 "comparison": "EQUAL",
34 "value": "string",
35 "values": [
36 "string"
37 ],
38 "from": "string",
39 "to": "string"
40 }
41}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "results": [
3 {
4 "id": 0,
5 "displayId": "string",
6 "quantity": 0,
7 "allocatedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "purchaseRequisitionId": 0,
34 "purchaseRequisitionDisplayId": "string",
35 "purchaseOrderLineItems": [
36 {
37 "id": 0,
38 "displayId": "string",
39 "quantity": 0,
40 "allocatedQuantity": 0,
41 "receivedQuantity": 0,
42 "unitPrice": 0,
43 "description": "string",
44 "expenseCategory": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "expenseCategoryType": "PAYMENT"
50 },
51 "costCenter": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string",
56 "erpSystemId": 0
57 },
58 "profitCenter": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string",
63 "validTo": "2019-08-24",
64 "erpSystemId": 0,
65 "erpSystemDisplayId": "string"
66 },
67 "taxJurisdiction": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "erpSystemId": 0,
73 "schema": "string",
74 "countryDisplayId": "string"
75 },
76 "taxCode": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "taxLineItems": [
84 {
85 "id": 0,
86 "taxRate": 0.1,
87 "taxAmount": 0,
88 "taxType": "string",
89 "purchaseOrderLineItemId": 0
90 }
91 ],
92 "purchaseOrderId": 0,
93 "purchaseOrderDisplayId": "string",
94 "purchaseOrderState": "INV_DRAFT",
95 "invoiceLineItems": [
96 {
97 "id": 0,
98 "displayId": "string",
99 "expenseCategory": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "expenseCategoryType": "PAYMENT"
105 },
106 "description": "string",
107 "unitOfMeasure": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "quantity": 0,
115 "unitPrice": 0,
116 "taxJurisdiction": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0,
122 "schema": "string",
123 "countryDisplayId": "string"
124 },
125 "taxCode": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "taxExpenseAccount": {
133 "id": 0,
134 "displayId": "string",
135 "generalLedgerAccountName": "string",
136 "generalLedgerAccountCode": "string",
137 "openItemManagement": true,
138 "accountCategory": "BALANCESHEET",
139 "shortName": "string",
140 "longName": "string"
141 },
142 "taxLineItems": [
143 {
144 "id": 0,
145 "taxRate": 0.1,
146 "taxAmount": 0,
147 "taxType": "string",
148 "invoiceLineItemId": 0
149 }
150 ],
151 "workBreakdownStructure": {
152 "id": 0,
153 "displayId": "string",
154 "status": "CREATED",
155 "name": "string",
156 "erpSystemId": 0
157 },
158 "costCenter": {
159 "id": 0,
160 "displayId": "string",
161 "status": "CREATED",
162 "name": "string",
163 "erpSystemId": 0
164 },
165 "profitCenter": {
166 "id": 0,
167 "displayId": "string",
168 "status": "CREATED",
169 "name": "string",
170 "validTo": "2019-08-24",
171 "erpSystemId": 0,
172 "erpSystemDisplayId": "string"
173 },
174 "functionalArea": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "businessArea": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "erpSystemId": 0
187 },
188 "segment": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0
194 },
195 "network": {
196 "id": 0,
197 "displayId": "string",
198 "status": "CREATED",
199 "name": "string",
200 "erpSystemId": 0
201 },
202 "internalOrderType": {
203 "id": 0,
204 "displayId": "string",
205 "status": "CREATED",
206 "name": "string",
207 "erpSystemId": 0
208 },
209 "internalOrder": {
210 "id": 0,
211 "displayId": "string",
212 "status": "CREATED",
213 "name": "string",
214 "erpSystemId": 0,
215 "internalOrderTypeId": 0
216 },
217 "additionalCurrencies": [
218 {
219 "id": 0,
220 "amount": 0,
221 "currency": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "decimalPoints": 0
227 },
228 "conversionRate": 0,
229 "conversionDate": "2019-08-24",
230 "translationDateType": "DOCUMENT_DATE",
231 "amountType": "NET_AMOUNT",
232 "currencyDefinitionType": "CONTRACT_CURRENCY",
233 "invoiceEntryId": 0,
234 "invoiceEntryDisplayId": "string"
235 }
236 ],
237 "scheduledPaymentMatches": [
238 {
239 "id": 0,
240 "fromId": 0,
241 "toId": 0,
242 "amount": 0
243 }
244 ],
245 "goodsReceiptLineItemLinks": [
246 {
247 "id": 0,
248 "fromId": 0,
249 "toId": 0,
250 "linkedQuantity": 0
251 }
252 ],
253 "invoiceId": 0,
254 "invoiceDisplayId": "string",
255 "invoiceState": "INV_DRAFT",
256 "vendorPaymentId": 0,
257 "purchaseOrderLineItemId": 0,
258 "netAmount": 0,
259 "allowsSystemGenerateNewId": true,
260 "numberRangeIdentifierValue": "string",
261 "numberRangeIdentifierType": {
262 "name": "string"
263 },
264 "numberRangeType": {
265 "name": "string"
266 }
267 }
268 ],
269 "goodsReceiptLineItems": [
270 {
271 "id": 0,
272 "displayId": "string",
273 "quantity": 0,
274 "invoicedQuantity": 0,
275 "description": "string",
276 "expenseCategory": {
277 "id": 0,
278 "displayId": "string",
279 "status": "CREATED",
280 "name": "string",
281 "expenseCategoryType": "PAYMENT"
282 },
283 "goodsReceiptId": 0,
284 "goodsReceiptDisplayId": "string",
285 "goodsReceiptState": "INV_DRAFT",
286 "purchaseOrderLineItemId": 0,
287 "invoiceLineItemLinks": [
288 {
289 "id": 0,
290 "fromId": 0,
291 "toId": 0,
292 "linkedQuantity": 0
293 }
294 ],
295 "availableQuantity": 0,
296 "allowsSystemGenerateNewId": true,
297 "numberRangeIdentifierValue": "string",
298 "numberRangeIdentifierType": {
299 "name": "string"
300 },
301 "numberRangeType": {
302 "name": "string"
303 }
304 }
305 ],
306 "vendorPaymentId": 0,
307 "purchaseRequisitionLineItemId": 0,
308 "purchaseRequisitionDisplayId": "string",
309 "purchaseRequisitionLineItemAvailableQuantity": 0,
310 "remainingQuantity": 0,
311 "availableQuantity": 0,
312 "allowsSystemGenerateNewId": true,
313 "numberRangeIdentifierValue": "string",
314 "numberRangeIdentifierType": {
315 "name": "string"
316 },
317 "numberRangeType": {
318 "name": "string"
319 }
320 }
321 ],
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "facets": {
334 "property1": {},
335 "property2": {}
336 },
337 "aggregations": {
338 "property1": {},
339 "property2": {}
340 },
341 "pagination": {
342 "number": 0,
343 "size": 0,
344 "totalElements": 0,
345 "totalPages": 0,
346 "first": true,
347 "last": true,
348 "empty": true,
349 "numberOfElements": 0
350 }
351}
List All Resources¶
HTTP Request
GET /api/v1/purchase-requisition-item
📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, allowing for efficient retrieval of purchase requisition items. |
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 "id": 0,
21 "displayId": "string",
22 "quantity": 0,
23 "allocatedQuantity": 0,
24 "unitPrice": 0,
25 "description": "string",
26 "expenseCategory": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "expenseCategoryType": "PAYMENT"
32 },
33 "costCenter": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0
39 },
40 "profitCenter": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "validTo": "2019-08-24",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string"
48 },
49 "purchaseRequisitionId": 0,
50 "purchaseRequisitionDisplayId": "string",
51 "purchaseOrderLineItems": [
52 {
53 "id": 0,
54 "displayId": "string",
55 "quantity": 0,
56 "allocatedQuantity": 0,
57 "receivedQuantity": 0,
58 "unitPrice": 0,
59 "description": "string",
60 "expenseCategory": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "expenseCategoryType": "PAYMENT"
66 },
67 "costCenter": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "erpSystemId": 0
73 },
74 "profitCenter": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "validTo": "2019-08-24",
80 "erpSystemId": 0,
81 "erpSystemDisplayId": "string"
82 },
83 "taxJurisdiction": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "erpSystemId": 0,
89 "schema": "string",
90 "countryDisplayId": "string"
91 },
92 "taxCode": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "taxLineItems": [
100 {
101 "id": 0,
102 "taxRate": 0.1,
103 "taxAmount": 0,
104 "taxType": "string",
105 "purchaseOrderLineItemId": 0
106 }
107 ],
108 "purchaseOrderId": 0,
109 "purchaseOrderDisplayId": "string",
110 "purchaseOrderState": "INV_DRAFT",
111 "invoiceLineItems": [
112 {
113 "id": 0,
114 "displayId": "string",
115 "expenseCategory": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "expenseCategoryType": "PAYMENT"
121 },
122 "description": "string",
123 "unitOfMeasure": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "quantity": 0,
131 "unitPrice": 0,
132 "taxJurisdiction": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0,
138 "schema": "string",
139 "countryDisplayId": "string"
140 },
141 "taxCode": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0
147 },
148 "taxExpenseAccount": {
149 "id": 0,
150 "displayId": "string",
151 "generalLedgerAccountName": "string",
152 "generalLedgerAccountCode": "string",
153 "openItemManagement": true,
154 "accountCategory": "BALANCESHEET",
155 "shortName": "string",
156 "longName": "string"
157 },
158 "taxLineItems": [
159 {
160 "id": 0,
161 "taxRate": 0.1,
162 "taxAmount": 0,
163 "taxType": "string",
164 "invoiceLineItemId": 0
165 }
166 ],
167 "workBreakdownStructure": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "costCenter": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "profitCenter": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "validTo": "2019-08-24",
187 "erpSystemId": 0,
188 "erpSystemDisplayId": "string"
189 },
190 "functionalArea": {
191 "id": 0,
192 "displayId": "string",
193 "status": "CREATED",
194 "name": "string",
195 "erpSystemId": 0
196 },
197 "businessArea": {
198 "id": 0,
199 "displayId": "string",
200 "status": "CREATED",
201 "name": "string",
202 "erpSystemId": 0
203 },
204 "segment": {
205 "id": 0,
206 "displayId": "string",
207 "status": "CREATED",
208 "name": "string",
209 "erpSystemId": 0
210 },
211 "network": {
212 "id": 0,
213 "displayId": "string",
214 "status": "CREATED",
215 "name": "string",
216 "erpSystemId": 0
217 },
218 "internalOrderType": {
219 "id": 0,
220 "displayId": "string",
221 "status": "CREATED",
222 "name": "string",
223 "erpSystemId": 0
224 },
225 "internalOrder": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "erpSystemId": 0,
231 "internalOrderTypeId": 0
232 },
233 "additionalCurrencies": [
234 {
235 "id": 0,
236 "amount": 0,
237 "currency": {
238 "id": 0,
239 "displayId": "string",
240 "status": "CREATED",
241 "name": "string",
242 "decimalPoints": 0
243 },
244 "conversionRate": 0,
245 "conversionDate": "2019-08-24",
246 "translationDateType": "DOCUMENT_DATE",
247 "amountType": "NET_AMOUNT",
248 "currencyDefinitionType": "CONTRACT_CURRENCY",
249 "invoiceEntryId": 0,
250 "invoiceEntryDisplayId": "string"
251 }
252 ],
253 "scheduledPaymentMatches": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "amount": 0
259 }
260 ],
261 "goodsReceiptLineItemLinks": [
262 {
263 "id": 0,
264 "fromId": 0,
265 "toId": 0,
266 "linkedQuantity": 0
267 }
268 ],
269 "invoiceId": 0,
270 "invoiceDisplayId": "string",
271 "invoiceState": "INV_DRAFT",
272 "vendorPaymentId": 0,
273 "purchaseOrderLineItemId": 0,
274 "netAmount": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284 ],
285 "goodsReceiptLineItems": [
286 {
287 "id": 0,
288 "displayId": "string",
289 "quantity": 0,
290 "invoicedQuantity": 0,
291 "description": "string",
292 "expenseCategory": {
293 "id": 0,
294 "displayId": "string",
295 "status": "CREATED",
296 "name": "string",
297 "expenseCategoryType": "PAYMENT"
298 },
299 "goodsReceiptId": 0,
300 "goodsReceiptDisplayId": "string",
301 "goodsReceiptState": "INV_DRAFT",
302 "purchaseOrderLineItemId": 0,
303 "invoiceLineItemLinks": [
304 {
305 "id": 0,
306 "fromId": 0,
307 "toId": 0,
308 "linkedQuantity": 0
309 }
310 ],
311 "availableQuantity": 0,
312 "allowsSystemGenerateNewId": true,
313 "numberRangeIdentifierValue": "string",
314 "numberRangeIdentifierType": {
315 "name": "string"
316 },
317 "numberRangeType": {
318 "name": "string"
319 }
320 }
321 ],
322 "vendorPaymentId": 0,
323 "purchaseRequisitionLineItemId": 0,
324 "purchaseRequisitionDisplayId": "string",
325 "purchaseRequisitionLineItemAvailableQuantity": 0,
326 "remainingQuantity": 0,
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "availableQuantity": 0,
339 "allowsSystemGenerateNewId": true,
340 "numberRangeIdentifierValue": "string",
341 "numberRangeIdentifierType": {
342 "name": "string"
343 },
344 "numberRangeType": {
345 "name": "string"
346 }
347 }
348 ],
349 "number": 0,
350 "sort": {
351 "unsorted": true,
352 "sorted": true,
353 "empty": true
354 },
355 "first": true,
356 "last": true,
357 "empty": true
358}
Create A Resource¶
HTTP Request
POST /api/v1/purchase-requisition-item
📋 Description: Creates a single resource. Returns the created resource with its generated ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the purchase requisition item, including item specifications, quantity, and associated cost information for procurement processing. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "unitPrice": 0,
7 "description": "string",
8 "expenseCategory": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "expenseCategoryType": "PAYMENT"
14 },
15 "costCenter": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "erpSystemId": 0
21 },
22 "profitCenter": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "validTo": "2019-08-24",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string"
30 },
31 "purchaseRequisitionId": 0,
32 "purchaseRequisitionDisplayId": "string",
33 "purchaseOrderLineItems": [
34 {
35 "id": 0,
36 "displayId": "string",
37 "quantity": 0,
38 "allocatedQuantity": 0,
39 "receivedQuantity": 0,
40 "unitPrice": 0,
41 "description": "string",
42 "expenseCategory": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "expenseCategoryType": "PAYMENT"
48 },
49 "costCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "erpSystemId": 0
55 },
56 "profitCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "validTo": "2019-08-24",
62 "erpSystemId": 0,
63 "erpSystemDisplayId": "string"
64 },
65 "taxJurisdiction": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "schema": "string",
72 "countryDisplayId": "string"
73 },
74 "taxCode": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "taxLineItems": [
82 {
83 "id": 0,
84 "taxRate": 0.1,
85 "taxAmount": 0,
86 "taxType": "string",
87 "purchaseOrderLineItemId": 0
88 }
89 ],
90 "purchaseOrderId": 0,
91 "purchaseOrderDisplayId": "string",
92 "purchaseOrderState": "INV_DRAFT",
93 "invoiceLineItems": [
94 {
95 "id": 0,
96 "displayId": "string",
97 "expenseCategory": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "expenseCategoryType": "PAYMENT"
103 },
104 "description": "string",
105 "unitOfMeasure": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0
111 },
112 "quantity": 0,
113 "unitPrice": 0,
114 "taxJurisdiction": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "schema": "string",
121 "countryDisplayId": "string"
122 },
123 "taxCode": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "taxExpenseAccount": {
131 "id": 0,
132 "displayId": "string",
133 "generalLedgerAccountName": "string",
134 "generalLedgerAccountCode": "string",
135 "openItemManagement": true,
136 "accountCategory": "BALANCESHEET",
137 "shortName": "string",
138 "longName": "string"
139 },
140 "taxLineItems": [
141 {
142 "id": 0,
143 "taxRate": 0.1,
144 "taxAmount": 0,
145 "taxType": "string",
146 "invoiceLineItemId": 0
147 }
148 ],
149 "workBreakdownStructure": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string",
154 "erpSystemId": 0
155 },
156 "costCenter": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "profitCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "validTo": "2019-08-24",
169 "erpSystemId": 0,
170 "erpSystemDisplayId": "string"
171 },
172 "functionalArea": {
173 "id": 0,
174 "displayId": "string",
175 "status": "CREATED",
176 "name": "string",
177 "erpSystemId": 0
178 },
179 "businessArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "segment": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "network": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "internalOrderType": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrder": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0,
213 "internalOrderTypeId": 0
214 },
215 "additionalCurrencies": [
216 {
217 "id": 0,
218 "amount": 0,
219 "currency": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "decimalPoints": 0
225 },
226 "conversionRate": 0,
227 "conversionDate": "2019-08-24",
228 "translationDateType": "DOCUMENT_DATE",
229 "amountType": "NET_AMOUNT",
230 "currencyDefinitionType": "CONTRACT_CURRENCY",
231 "invoiceEntryId": 0,
232 "invoiceEntryDisplayId": "string"
233 }
234 ],
235 "scheduledPaymentMatches": [
236 {
237 "id": 0,
238 "fromId": 0,
239 "toId": 0,
240 "amount": 0
241 }
242 ],
243 "goodsReceiptLineItemLinks": [
244 {
245 "id": 0,
246 "fromId": 0,
247 "toId": 0,
248 "linkedQuantity": 0
249 }
250 ],
251 "invoiceId": 0,
252 "invoiceDisplayId": "string",
253 "invoiceState": "INV_DRAFT",
254 "vendorPaymentId": 0,
255 "purchaseOrderLineItemId": 0,
256 "netAmount": 0,
257 "allowsSystemGenerateNewId": true,
258 "numberRangeIdentifierValue": "string",
259 "numberRangeIdentifierType": {
260 "name": "string"
261 },
262 "numberRangeType": {
263 "name": "string"
264 }
265 }
266 ],
267 "goodsReceiptLineItems": [
268 {
269 "id": 0,
270 "displayId": "string",
271 "quantity": 0,
272 "invoicedQuantity": 0,
273 "description": "string",
274 "expenseCategory": {
275 "id": 0,
276 "displayId": "string",
277 "status": "CREATED",
278 "name": "string",
279 "expenseCategoryType": "PAYMENT"
280 },
281 "goodsReceiptId": 0,
282 "goodsReceiptDisplayId": "string",
283 "goodsReceiptState": "INV_DRAFT",
284 "purchaseOrderLineItemId": 0,
285 "invoiceLineItemLinks": [
286 {
287 "id": 0,
288 "fromId": 0,
289 "toId": 0,
290 "linkedQuantity": 0
291 }
292 ],
293 "allowsSystemGenerateNewId": true,
294 "numberRangeIdentifierValue": "string",
295 "numberRangeIdentifierType": {
296 "name": "string"
297 },
298 "numberRangeType": {
299 "name": "string"
300 }
301 }
302 ],
303 "vendorPaymentId": 0,
304 "purchaseRequisitionLineItemId": 0,
305 "purchaseRequisitionDisplayId": "string",
306 "purchaseRequisitionLineItemAvailableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "quantity": 0,
18 "allocatedQuantity": 0,
19 "unitPrice": 0,
20 "description": "string",
21 "expenseCategory": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "expenseCategoryType": "PAYMENT"
27 },
28 "costCenter": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "validTo": "2019-08-24",
41 "erpSystemId": 0,
42 "erpSystemDisplayId": "string"
43 },
44 "purchaseRequisitionId": 0,
45 "purchaseRequisitionDisplayId": "string",
46 "purchaseOrderLineItems": [
47 {
48 "id": 0,
49 "displayId": "string",
50 "quantity": 0,
51 "allocatedQuantity": 0,
52 "receivedQuantity": 0,
53 "unitPrice": 0,
54 "description": "string",
55 "expenseCategory": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "expenseCategoryType": "PAYMENT"
61 },
62 "costCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "erpSystemId": 0
68 },
69 "profitCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "validTo": "2019-08-24",
75 "erpSystemId": 0,
76 "erpSystemDisplayId": "string"
77 },
78 "taxJurisdiction": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0,
84 "schema": "string",
85 "countryDisplayId": "string"
86 },
87 "taxCode": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "taxLineItems": [
95 {
96 "id": 0,
97 "taxRate": 0.1,
98 "taxAmount": 0,
99 "taxType": "string",
100 "purchaseOrderLineItemId": 0
101 }
102 ],
103 "purchaseOrderId": 0,
104 "purchaseOrderDisplayId": "string",
105 "purchaseOrderState": "INV_DRAFT",
106 "invoiceLineItems": [
107 {
108 "id": 0,
109 "displayId": "string",
110 "expenseCategory": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "expenseCategoryType": "PAYMENT"
116 },
117 "description": "string",
118 "unitOfMeasure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "quantity": 0,
126 "unitPrice": 0,
127 "taxJurisdiction": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "schema": "string",
134 "countryDisplayId": "string"
135 },
136 "taxCode": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "taxExpenseAccount": {
144 "id": 0,
145 "displayId": "string",
146 "generalLedgerAccountName": "string",
147 "generalLedgerAccountCode": "string",
148 "openItemManagement": true,
149 "accountCategory": "BALANCESHEET",
150 "shortName": "string",
151 "longName": "string"
152 },
153 "taxLineItems": [
154 {
155 "id": 0,
156 "taxRate": 0.1,
157 "taxAmount": 0,
158 "taxType": "string",
159 "invoiceLineItemId": 0
160 }
161 ],
162 "workBreakdownStructure": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "costCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "profitCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "validTo": "2019-08-24",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string"
184 },
185 "functionalArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "businessArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "segment": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "network": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrderType": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrder": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0,
226 "internalOrderTypeId": 0
227 },
228 "additionalCurrencies": [
229 {
230 "id": 0,
231 "amount": 0,
232 "currency": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "decimalPoints": 0
238 },
239 "conversionRate": 0,
240 "conversionDate": "2019-08-24",
241 "translationDateType": "DOCUMENT_DATE",
242 "amountType": "NET_AMOUNT",
243 "currencyDefinitionType": "CONTRACT_CURRENCY",
244 "invoiceEntryId": 0,
245 "invoiceEntryDisplayId": "string"
246 }
247 ],
248 "scheduledPaymentMatches": [
249 {
250 "id": 0,
251 "fromId": 0,
252 "toId": 0,
253 "amount": 0
254 }
255 ],
256 "goodsReceiptLineItemLinks": [
257 {
258 "id": 0,
259 "fromId": 0,
260 "toId": 0,
261 "linkedQuantity": 0
262 }
263 ],
264 "invoiceId": 0,
265 "invoiceDisplayId": "string",
266 "invoiceState": "INV_DRAFT",
267 "vendorPaymentId": 0,
268 "purchaseOrderLineItemId": 0,
269 "netAmount": 0,
270 "allowsSystemGenerateNewId": true,
271 "numberRangeIdentifierValue": "string",
272 "numberRangeIdentifierType": {
273 "name": "string"
274 },
275 "numberRangeType": {
276 "name": "string"
277 }
278 }
279 ],
280 "goodsReceiptLineItems": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "quantity": 0,
285 "invoicedQuantity": 0,
286 "description": "string",
287 "expenseCategory": {
288 "id": 0,
289 "displayId": "string",
290 "status": "CREATED",
291 "name": "string",
292 "expenseCategoryType": "PAYMENT"
293 },
294 "goodsReceiptId": 0,
295 "goodsReceiptDisplayId": "string",
296 "goodsReceiptState": "INV_DRAFT",
297 "purchaseOrderLineItemId": 0,
298 "invoiceLineItemLinks": [
299 {
300 "id": 0,
301 "fromId": 0,
302 "toId": 0,
303 "linkedQuantity": 0
304 }
305 ],
306 "availableQuantity": 0,
307 "allowsSystemGenerateNewId": true,
308 "numberRangeIdentifierValue": "string",
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeType": {
313 "name": "string"
314 }
315 }
316 ],
317 "vendorPaymentId": 0,
318 "purchaseRequisitionLineItemId": 0,
319 "purchaseRequisitionDisplayId": "string",
320 "purchaseRequisitionLineItemAvailableQuantity": 0,
321 "remainingQuantity": 0,
322 "availableQuantity": 0,
323 "allowsSystemGenerateNewId": true,
324 "numberRangeIdentifierValue": "string",
325 "numberRangeIdentifierType": {
326 "name": "string"
327 },
328 "numberRangeType": {
329 "name": "string"
330 }
331 }
332 ],
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343}